You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
242 lines
9.3 KiB
242 lines
9.3 KiB
2 years ago
|
<?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/>.
|
||
|
|
//
|
||
|
|
// This file is part of BasicLTI4Moodle
|
||
|
|
//
|
||
|
|
// BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
|
||
|
|
// consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
|
||
|
|
// based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
|
||
|
|
// specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
|
||
|
|
// are already supporting or going to support BasicLTI. This project Implements the consumer
|
||
|
|
// for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
|
||
|
|
// BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
|
||
|
|
// at the GESSI research group at UPC.
|
||
|
|
// SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
|
||
|
|
// by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
|
||
|
|
// Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
|
||
|
|
//
|
||
|
|
// BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
|
||
|
|
// of the Universitat Politecnica de Catalunya http://www.upc.edu
|
||
|
|
// Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This file contains all the backup steps that will be used
|
||
|
|
* by the backup_lti_activity_task
|
||
|
|
*
|
||
|
|
* @package mod_lti
|
||
|
|
* @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
|
||
|
|
* marc.alier@upc.edu
|
||
|
|
* @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
|
||
|
|
* @author Marc Alier
|
||
|
|
* @author Jordi Piguillem
|
||
|
|
* @author Nikolas Galanis
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('MOODLE_INTERNAL') || die;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Define the complete assignment structure for backup, with file and id annotations
|
||
|
|
*/
|
||
|
|
class backup_lti_activity_structure_step extends backup_activity_structure_step {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Defines structure of activity backup
|
||
|
|
* @return backup_nested_element
|
||
|
|
*/
|
||
|
|
protected function define_structure() {
|
||
|
|
global $DB;
|
||
|
|
|
||
|
|
// To know if we are including userinfo.
|
||
|
|
$userinfo = $this->get_setting_value('userinfo');
|
||
|
|
|
||
|
|
// Define each element separated.
|
||
|
|
$lti = new backup_nested_element('lti', array('id'), array(
|
||
|
|
'name',
|
||
|
|
'intro',
|
||
|
|
'introformat',
|
||
|
|
'timecreated',
|
||
|
|
'timemodified',
|
||
|
|
'typeid',
|
||
|
|
'toolurl',
|
||
|
|
'securetoolurl',
|
||
|
|
'preferheight',
|
||
|
|
'launchcontainer',
|
||
|
|
'instructorchoicesendname',
|
||
|
|
'instructorchoicesendemailaddr',
|
||
|
|
'instructorchoiceacceptgrades',
|
||
|
|
'instructorchoiceallowroster',
|
||
|
|
'instructorchoiceallowsetting',
|
||
|
|
'grade',
|
||
|
|
'instructorcustomparameters',
|
||
|
|
'debuglaunch',
|
||
|
|
'showtitlelaunch',
|
||
|
|
'showdescriptionlaunch',
|
||
|
|
'icon',
|
||
|
|
'secureicon',
|
||
|
|
new encrypted_final_element('resourcekey'),
|
||
|
|
new encrypted_final_element('password'),
|
||
|
|
)
|
||
|
|
);
|
||
|
|
|
||
|
|
$ltitype = new backup_nested_element('ltitype', array('id'), array(
|
||
|
|
'name',
|
||
|
|
'baseurl',
|
||
|
|
'tooldomain',
|
||
|
|
'state',
|
||
|
|
'course',
|
||
|
|
'coursevisible',
|
||
|
|
'ltiversion',
|
||
|
|
'clientid',
|
||
|
|
'toolproxyid',
|
||
|
|
'enabledcapability',
|
||
|
|
'parameter',
|
||
|
|
'icon',
|
||
|
|
'secureicon',
|
||
|
|
'createdby',
|
||
|
|
'timecreated',
|
||
|
|
'timemodified',
|
||
|
|
'description'
|
||
|
|
)
|
||
|
|
);
|
||
|
|
|
||
|
|
$ltitypesconfigs = new backup_nested_element('ltitypesconfigs');
|
||
|
|
$ltitypesconfig = new backup_nested_element('ltitypesconfig', array('id'), array(
|
||
|
|
'name',
|
||
|
|
'value',
|
||
|
|
)
|
||
|
|
);
|
||
|
|
$ltitypesconfigencrypted = new backup_nested_element('ltitypesconfigencrypted', array('id'), array(
|
||
|
|
'name',
|
||
|
|
new encrypted_final_element('value'),
|
||
|
|
)
|
||
|
|
);
|
||
|
|
|
||
|
|
$ltitoolproxy = new backup_nested_element('ltitoolproxy', array('id'));
|
||
|
|
|
||
|
|
$ltitoolsettings = new backup_nested_element('ltitoolsettings');
|
||
|
|
$ltitoolsetting = new backup_nested_element('ltitoolsetting', array('id'), array(
|
||
|
|
'settings',
|
||
|
|
'timecreated',
|
||
|
|
'timemodified',
|
||
|
|
)
|
||
|
|
);
|
||
|
|
|
||
|
|
$ltisubmissions = new backup_nested_element('ltisubmissions');
|
||
|
|
$ltisubmission = new backup_nested_element('ltisubmission', array('id'), array(
|
||
|
|
'userid',
|
||
|
|
'datesubmitted',
|
||
|
|
'dateupdated',
|
||
|
|
'gradepercent',
|
||
|
|
'originalgrade',
|
||
|
|
'launchid',
|
||
|
|
'state'
|
||
|
|
));
|
||
|
|
|
||
|
|
// Build the tree
|
||
|
|
$lti->add_child($ltitype);
|
||
|
|
$ltitype->add_child($ltitypesconfigs);
|
||
|
|
$ltitypesconfigs->add_child($ltitypesconfig);
|
||
|
|
$ltitypesconfigs->add_child($ltitypesconfigencrypted);
|
||
|
|
$ltitype->add_child($ltitoolproxy);
|
||
|
|
$ltitoolproxy->add_child($ltitoolsettings);
|
||
|
|
$ltitoolsettings->add_child($ltitoolsetting);
|
||
|
|
$lti->add_child($ltisubmissions);
|
||
|
|
$ltisubmissions->add_child($ltisubmission);
|
||
|
|
|
||
|
|
// Define sources.
|
||
|
|
$ltirecord = $DB->get_record('lti', ['id' => $this->task->get_activityid()]);
|
||
|
|
$lti->set_source_array([$ltirecord]);
|
||
|
|
|
||
|
|
$ltitypedata = $this->retrieve_lti_type($ltirecord);
|
||
|
|
$ltitype->set_source_array($ltitypedata ? [$ltitypedata] : []);
|
||
|
|
|
||
|
|
if (isset($ltitypedata->baseurl)) {
|
||
|
|
// Add type config values only if the type was backed up. Encrypt password and resourcekey.
|
||
|
|
$params = [backup_helper::is_sqlparam($ltitypedata->id),
|
||
|
|
backup_helper::is_sqlparam('password'),
|
||
|
|
backup_helper::is_sqlparam('resourcekey')];
|
||
|
|
$ltitypesconfig->set_source_sql("SELECT id, name, value
|
||
|
|
FROM {lti_types_config}
|
||
|
|
WHERE typeid = ? AND name <> ? AND name <> ?", $params);
|
||
|
|
$ltitypesconfigencrypted->set_source_sql("SELECT id, name, value
|
||
|
|
FROM {lti_types_config}
|
||
|
|
WHERE typeid = ? AND (name = ? OR name = ?)", $params);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($ltitypedata->toolproxyid)) {
|
||
|
|
// If this is LTI 2 tool add settings for the current activity.
|
||
|
|
$ltitoolproxy->set_source_array([['id' => $ltitypedata->toolproxyid]]);
|
||
|
|
$ltitoolsetting->set_source_sql("SELECT *
|
||
|
|
FROM {lti_tool_settings}
|
||
|
|
WHERE toolproxyid = ? AND course = ? AND coursemoduleid = ?",
|
||
|
|
[backup_helper::is_sqlparam($ltitypedata->toolproxyid), backup::VAR_COURSEID, backup::VAR_MODID]);
|
||
|
|
} else {
|
||
|
|
$ltitoolproxy->set_source_array([]);
|
||
|
|
}
|
||
|
|
|
||
|
|
// All the rest of elements only happen if we are including user info.
|
||
|
|
if ($userinfo) {
|
||
|
|
$ltisubmission->set_source_table('lti_submission', array('ltiid' => backup::VAR_ACTIVITYID));
|
||
|
|
}
|
||
|
|
|
||
|
|
// Define id annotations
|
||
|
|
$ltitype->annotate_ids('user', 'createdby');
|
||
|
|
$ltitype->annotate_ids('course', 'course');
|
||
|
|
$ltisubmission->annotate_ids('user', 'userid');
|
||
|
|
|
||
|
|
// Define file annotations.
|
||
|
|
$lti->annotate_files('mod_lti', 'intro', null); // This file areas haven't itemid.
|
||
|
|
|
||
|
|
// Add support for subplugin structures.
|
||
|
|
$this->add_subplugin_structure('ltisource', $lti, true);
|
||
|
|
$this->add_subplugin_structure('ltiservice', $lti, true);
|
||
|
|
|
||
|
|
// Return the root element (lti), wrapped into standard activity structure.
|
||
|
|
return $this->prepare_activity_structure($lti);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieves a record from {lti_type} table associated with the current activity
|
||
|
|
*
|
||
|
|
* Information about site tools is not returned because it is insecure to back it up,
|
||
|
|
* only fields necessary for same-site tool matching are left in the record
|
||
|
|
*
|
||
|
|
* @param stdClass $ltirecord record from {lti} table
|
||
|
|
* @return stdClass|null
|
||
|
|
*/
|
||
|
|
protected function retrieve_lti_type($ltirecord) {
|
||
|
|
global $DB;
|
||
|
|
if (!$ltirecord->typeid) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
$record = $DB->get_record('lti_types', ['id' => $ltirecord->typeid]);
|
||
|
|
if ($record && $record->course == SITEID) {
|
||
|
|
// Site LTI types or registrations are not backed up except for their name (which is visible).
|
||
|
|
// Predefined course types can be backed up.
|
||
|
|
$allowedkeys = ['id', 'course', 'name', 'toolproxyid'];
|
||
|
|
foreach ($record as $key => $value) {
|
||
|
|
if (!in_array($key, $allowedkeys)) {
|
||
|
|
$record->$key = null;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $record;
|
||
|
|
}
|
||
|
|
}
|