moodle/mod/lti/servicelib.php

311 lines
9.9 KiB
PHP
Raw Normal View History

<?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
*/
2011-11-07 01:56:00 +01:00
defined('MOODLE_INTERNAL') || die;
require_once($CFG->dirroot.'/mod/lti/OAuthBody.php');
require_once($CFG->dirroot.'/mod/lti/locallib.php');
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
// 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);
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
$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) {
if (empty($xml->imsx_POXHeader)) {
return '';
}
$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);
if ( is_null($resultjson) ) {
throw new Exception('Invalid sourcedId in result message');
}
$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();
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$parsed->gradeval = $grade;
$parsed->instanceid = $resultjson->data->instanceid;
$parsed->userid = $resultjson->data->userid;
2011-09-28 11:11:20 -04:00
$parsed->launchid = $resultjson->data->launchid;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$parsed->typeid = $resultjson->data->typeid;
$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);
if ( is_null($resultjson) ) {
throw new Exception('Invalid sourcedId in result message');
}
$parsed = new stdClass();
$parsed->instanceid = $resultjson->data->instanceid;
$parsed->userid = $resultjson->data->userid;
2011-09-28 11:11:20 -04:00
$parsed->launchid = $resultjson->data->launchid;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$parsed->typeid = $resultjson->data->typeid;
$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);
if ( is_null($resultjson) ) {
throw new Exception('Invalid sourcedId in result message');
}
$parsed = new stdClass();
$parsed->instanceid = $resultjson->data->instanceid;
$parsed->userid = $resultjson->data->userid;
2011-09-28 11:11:20 -04:00
$parsed->launchid = $resultjson->data->launchid;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$parsed->typeid = $resultjson->data->typeid;
$parsed->sourcedidhash = $resultjson->hash;
$parsed->messageid = lti_parse_message_id($xml);
return $parsed;
}
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
function lti_accepts_grades($ltiinstance) {
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
global $DB;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$acceptsgrades = true;
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
$ltitype = $DB->get_record('lti_types', array('id' => $ltiinstance->typeid));
if (empty($ltitype->toolproxyid)) {
$typeconfig = lti_get_config($ltiinstance);
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
$typeacceptgrades = isset($typeconfig['acceptgrades']) ? $typeconfig['acceptgrades'] : LTI_SETTING_DELEGATE;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
if (!($typeacceptgrades == LTI_SETTING_ALWAYS ||
($typeacceptgrades == LTI_SETTING_DELEGATE && $ltiinstance->instructorchoiceacceptgrades == LTI_SETTING_ALWAYS))) {
$acceptsgrades = false;
}
} else {
$enabledcapabilities = explode("\n", $ltitype->enabledcapability);
$acceptsgrades = in_array('Result.autocreate', $enabledcapabilities) || in_array('BasicOutcome.url', $enabledcapabilities);
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
}
return $acceptsgrades;
}
/**
* Set the passed user ID to the session user.
*
* @param int $userid
*/
function lti_set_session_user($userid) {
global $DB;
if ($user = $DB->get_record('user', array('id' => $userid))) {
\core\session\manager::set_user($user);
}
}
function lti_update_grade($ltiinstance, $userid, $launchid, $gradeval) {
2011-09-28 11:11:20 -04:00
global $CFG, $DB;
require_once($CFG->libdir . '/gradelib.php');
$params = array();
$params['itemname'] = $ltiinstance->name;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$gradeval = $gradeval * floatval($ltiinstance->grade);
$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);
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
$record = $DB->get_record('lti_submission', array('ltiid' => $ltiinstance->id, 'userid' => $userid,
'launchid' => $launchid), 'id');
if ($record) {
2011-09-28 11:11:20 -04:00
$id = $record->id;
} else {
$id = null;
}
if (!empty($id)) {
2011-09-28 11:11:20 -04:00
$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(),
2011-09-28 11:11:20 -04:00
'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);
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$ltigrade = floatval($ltiinstance->grade);
if (!empty($ltigrade) && isset($grades) && isset($grades->items[0]) && is_array($grades->items[0]->grades)) {
foreach ($grades->items[0]->grades as $agrade) {
$grade = $agrade->grade;
if (isset($grade)) {
return $grade / $ltigrade;
}
}
}
}
function lti_delete_grade($ltiinstance, $userid) {
global $CFG;
require_once($CFG->libdir . '/gradelib.php');
$grade = new stdClass();
$grade->userid = $userid;
$grade->rawgrade = null;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$status = grade_update(LTI_SOURCE, $ltiinstance->course, LTI_ITEM_TYPE, LTI_ITEM_MODULE, $ltiinstance->id, 0, $grade);
return $status == GRADE_UPDATE_OK;
}
function lti_verify_message($key, $sharedsecrets, $body, $headers = null) {
foreach ($sharedsecrets as $secret) {
$signaturefailed = false;
try {
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
// TODO: Switch to core oauthlib once implemented - MDL-30149.
lti\handle_oauth_body_post($key, $secret, $body, $headers);
} catch (Exception $e) {
debugging('LTI message verification failed: '.$e->getMessage());
$signaturefailed = true;
}
if (!$signaturefailed) {
MDL-45843 mod_lti: introduced support to LTI 2.0 This commit introduces support to the LTI module for LTI 2.0. As well as the initial commit the following changes were made and then squashed into the single commit for integration: * Fixed bug in services Fixed bug which limited characters allowed in values of template variables (e.g. vendor ID) in service endpoints. Changed language file to refer to tool registrations rather than tool proxies. * Refactored service classes Moved classes relating to services into areas where Moodle will autoload them * Ran code through code checker Removed all errors reported by the Code checker module excluding third-party OAuth.php file. * UI improvements Mainly when adding an external tool to a course - fields which should not be changed for a selected tool are either hidden or disabled. Admin settings page now shows the Tool Registration name against a tool rather than the launch URL, and the registration URL replaces the GUID on the tool registrations page. * Updated tool proxy registration Added check of tool proxy to ensure only offered capabilities and services are included. Also check tool proxy when processing a service request. * Code review changes Some fixes based on code review by Mark Nielsen and addition of some PHPDocs comments. * Updates from code/PHPdocs checks Removed use of eval and corrected invalid PHPdocs for new functions/classes * Corrected namespace error and incorrect string terminator * Updates based on forum feedback Added dependencies and backup, restore and uninstall methods for ltiservice subplugins. Changed most uses of is_null to empty * Updated custom parameters test Updated test_split_custom_parameters to include new function parameters. Corrected PHPdoc entry for lti_split_custom_parameters Fixed incorrect line separators in ltiservice.php * Added require_capability to registrationreturn.php * SQL and EOL updates Moved PHP variable in SQL into a named parameter Improved checks for end-of-line characters to include CR and LF on their own or together * Check for semicolon separators Semicolon separators in custom parameters are changed to EOL characters when upgrading to the 2014100100 version. * Remove unused file basiclti.js file not being used so removed. * Adjust line lengths Split long lines in upgrade.php * Added savepoint to upgrade.php savepoint omitted from earlier update to upgrade.php * Updated namespaces and upgrade Service and resource classes moved into .../local/... Upgrade SQL moved into a function and unit test created * Updated lti_tool_proxies table Added indices and foreign keys to lti_tool_proxies table * Fixed formatting and documentation issues * ltiservice class moved into local * Replaced lti_scale_used comments Put back commented out code for lti_scale_used * Removed redundant sesskey code * Fixed namespace and path check Updated ltiservice namespace for move into local Added check for existence of $_SERVER['PATH_INFO'] * Updated upgrade code Added indices and keys to lti_tool_settings table when upgrading Fixed errors in upgradelib_test.php (thanks to jleyva) Update SQL to use Moodle functions * Use of empty with class method PHP 5.4 does not like the use of empty with a class method so saved the value to a variable first. PHP 5.5 seems to accept the use of a method with empty. * Removed redundant indices Removed creation of indices for foreign keys on lti_tool_settings table from install.xml and upgrade.php * Fixes based on feedback Minor changes and corrections based on review in JIRA * Fixed bug in toolproxy service Corrected bug which failed to respond properly to an invalid request Also updated upgrade.txt file * Improved admin navigation Added the manage tool registrations page as a separate entry on the admin menu (within a folder named LTI). Made this entry the current position for the related pages. * Updated PHPdocs with class names Added class names with namespaces to PHPdocs to replace generic references to "object" * Changed object to iframe Use of object tag in register.php changed to use an iframe tag in line with the similar update made to view.php. * Improved registration process A message is now displayed if the registration page has not been loaded in the iframe within 20 seconds. If a user is returned to Moodle without a tool proxy being sent, the registration is moved back from pending to configured. * Fixes for integration Removed comment - the template is the default path unless overridden, so get_path and get_template should both be defined. Added comment and intval to fix the issue with obtaining an error reason.
2014-09-03 23:35:39 +01:00
return $secret; // Return the secret used to sign the message).
}
}
return false;
}
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
/**
* Validate source ID from external request
*
* @param object $ltiinstance
* @param object $parsed
* @throws Exception
*/
function lti_verify_sourcedid($ltiinstance, $parsed) {
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
$sourceid = lti_build_sourcedid($parsed->instanceid, $parsed->userid,
$ltiinstance->servicesalt, $parsed->typeid, $parsed->launchid);
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)) {
// There can only be one.
if (count($plugins) > 1) {
throw new coding_exception('More than one ltisource plugin handler found');
}
$data->xml = new SimpleXMLElement($data->body);
$callback = current($plugins);
call_user_func($callback, $data);
return true;
}
return false;
MDL-44902: Several additions to External Tool (LTI) * LTI service related changes: ** Fixing exceptions in OAuth library. ** Added new launch option, Existing window: replaces entire page with the LTI object. ** The LTI tool ID used to perform the launch is now sent with the LTI launch parameters. This is sent back to Moodle on subsequent requests. ** Added $CFG->mod_lti_forcessl to force SSL on all LTI launches. ** Added new LTI launch parameter: tool_consumer_instance_name. Default value is site full name, but can be customized with $CFG->mod_lti_institution_name. ** The LTI grade service endpoints now set the affected user to the session. This was required for event listeners. ** Fix the grade deletion service. Was deleting the grade item instead of just the grade. ** Send error response when LTI instance does not accept grades and grades are being sent. ** Added a method for writing incoming LTI requests to disk for debugging. Disabled by default. * Changes for ltisource plugins: ** Can now to plug into backup/restore. ** Can now have settings.php files. ** Can now hook into the LTI launch and edit parameters. * Several grade changes: ** Added standard_grading_coursemodule_elements to LTI instance edit form. This means LTI instances can be configured with a grade. ** No longer assumes that grade is out of 100. ** Replaced modl/lti:grade capability with mod/lti:view. * JS on mod/lti/view.php for resizing the content object has been converted to YUI3. * Fixed misspellings in language file. * Added hooks for log post and view actions. * Bug fix for lti_get_url_thumbprint() when the URL is missing a schema.
2014-04-01 15:07:54 -07:00
}