Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/lti/ -> lib.php (source)
<?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/>.

/**
 * LTI enrolment plugin main library file.
 *
 * @package enrol_lti
 * @copyright 2016 Mark Nelson <markn@moodle.com>
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

use enrol_lti\data_connector;
> use enrol_lti\local\ltiadvantage\repository\resource_link_repository;
use IMSGlobal\LTI\ToolProvider\ToolConsumer; defined('MOODLE_INTERNAL') || die(); /** * LTI enrolment plugin class. * * @package enrol_lti * @copyright 2016 Mark Nelson <markn@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class enrol_lti_plugin extends enrol_plugin { /** * Return true if we can add a new instance to this course. * * @param int $courseid * @return boolean */ public function can_add_instance($courseid) { $context = context_course::instance($courseid, MUST_EXIST); return has_capability('moodle/course:enrolconfig', $context) && has_capability('enrol/lti:config', $context); } /** * Is it possible to delete enrol instance via standard UI? * * @param object $instance * @return bool */ public function can_delete_instance($instance) { $context = context_course::instance($instance->courseid); return has_capability('enrol/lti:config', $context); } /** * Is it possible to hide/show enrol instance via standard UI? * * @param stdClass $instance * @return bool */ public function can_hide_show_instance($instance) { $context = context_course::instance($instance->courseid); return has_capability('enrol/lti:config', $context); } /** * Returns true if it's possible to unenrol users. * * @param stdClass $instance course enrol instance * @return bool */ public function allow_unenrol(stdClass $instance) { return true; } /** * We are a good plugin and don't invent our own UI/validation code path. * * @return boolean */ public function use_standard_editing_ui() { return true; } /** * Add new instance of enrol plugin. * * @param object $course * @param array $fields instance fields * @return int id of new instance, null if can not be created */ public function add_instance($course, array $fields = null) { global $DB; $instanceid = parent::add_instance($course, $fields); // Add additional data to our table. $data = new stdClass(); $data->enrolid = $instanceid; $data->timecreated = time(); $data->timemodified = $data->timecreated; foreach ($fields as $field => $value) { $data->$field = $value; }
> // LTI Advantage: make a unique identifier for the published resource. $DB->insert_record('enrol_lti_tools', $data); > if (empty($data->ltiversion) || $data->ltiversion == 'LTI-1p3') { > $data->uuid = \core\uuid::generate(); return $instanceid; > } } >
/** * Update instance of enrol plugin. * * @param stdClass $instance * @param stdClass $data modified instance fields * @return boolean */ public function update_instance($instance, $data) { global $DB; parent::update_instance($instance, $data); // Remove the fields we don't want to override. unset($data->id); unset($data->timecreated); unset($data->timemodified); // Convert to an array we can loop over. $fields = (array) $data; // Update the data in our table. $tool = new stdClass(); $tool->id = $data->toolid; $tool->timemodified = time(); foreach ($fields as $field => $value) { $tool->$field = $value; }
> // LTI Advantage: make a unique identifier for the published resource. return $DB->update_record('enrol_lti_tools', $tool); > if ($tool->ltiversion == 'LTI-1p3' && empty($tool->uuid)) { } > $tool->uuid = \core\uuid::generate(); > } /** >
* Delete plugin specific information. * * @param stdClass $instance * @return void */ public function delete_instance($instance) { global $DB; // Get the tool associated with this instance. $tool = $DB->get_record('enrol_lti_tools', array('enrolid' => $instance->id), 'id', MUST_EXIST);
> // LTI Advantage: delete any resource_link and user_resource_link mappings. // Delete any users associated with this tool. > $resourcelinkrepo = new resource_link_repository(); $DB->delete_records('enrol_lti_users', array('toolid' => $tool->id)); > $resourcelinkrepo->delete_by_resource($tool->id); >
// Get tool and consumer mappings. $rsmapping = $DB->get_recordset('enrol_lti_tool_consumer_map', array('toolid' => $tool->id)); // Delete consumers that are linked to this tool and their related data. $dataconnector = new data_connector(); foreach ($rsmapping as $mapping) { $consumer = new ToolConsumer(null, $dataconnector); $consumer->setRecordId($mapping->consumerid); $dataconnector->deleteToolConsumer($consumer); } $rsmapping->close(); // Delete mapping records. $DB->delete_records('enrol_lti_tool_consumer_map', array('toolid' => $tool->id)); // Delete the lti tool record. $DB->delete_records('enrol_lti_tools', array('id' => $tool->id)); // Time for the parent to do it's thang, yeow. parent::delete_instance($instance); } /** * Handles un-enrolling a user. * * @param stdClass $instance * @param int $userid * @return void */ public function unenrol_user(stdClass $instance, $userid) { global $DB; // Get the tool associated with this instance. Note - it may not exist if we have deleted // the tool. This is fine because we have already cleaned the 'enrol_lti_users' table. if ($tool = $DB->get_record('enrol_lti_tools', array('enrolid' => $instance->id), 'id')) { // Need to remove the user from the users table. $DB->delete_records('enrol_lti_users', array('userid' => $userid, 'toolid' => $tool->id)); } parent::unenrol_user($instance, $userid); } /** * Add elements to the edit instance form. * * @param stdClass $instance * @param MoodleQuickForm $mform * @param context $context * @return bool */ public function edit_instance_form($instance, MoodleQuickForm $mform, $context) { global $DB;
> $versionoptions = [ $nameattribs = array('size' => '20', 'maxlength' => '255'); > 'LTI-1p3' => get_string('lti13', 'enrol_lti'), $mform->addElement('text', 'name', get_string('custominstancename', 'enrol'), $nameattribs); > 'LTI-1p0/LTI-2p0' => get_string('ltilegacy', 'enrol_lti') $mform->setType('name', PARAM_TEXT); > ]; $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'server'); > $mform->addElement('select', 'ltiversion', get_string('ltiversion', 'enrol_lti'), $versionoptions); > $mform->addHelpButton('ltiversion', 'ltiversion', 'enrol_lti'); $tools = array(); > $legacy = optional_param('legacy', 0, PARAM_INT); $tools[$context->id] = get_string('course'); > if (empty($instance->id)) { $modinfo = get_fast_modinfo($instance->courseid); > $mform->setDefault('ltiversion', $legacy ? 'LTI-1p0/LTI-2p0' : 'LTI-1p3'); $mods = $modinfo->get_cms(); > } foreach ($mods as $mod) { >
$tools[$mod->context->id] = format_string($mod->name); } $mform->addElement('select', 'contextid', get_string('tooltobeprovided', 'enrol_lti'), $tools); $mform->setDefault('contextid', $context->id); $mform->addElement('duration', 'enrolperiod', get_string('enrolperiod', 'enrol_lti'), array('optional' => true, 'defaultunit' => DAYSECS)); $mform->setDefault('enrolperiod', 0); $mform->addHelpButton('enrolperiod', 'enrolperiod', 'enrol_lti'); $mform->addElement('date_time_selector', 'enrolstartdate', get_string('enrolstartdate', 'enrol_lti'), array('optional' => true)); $mform->setDefault('enrolstartdate', 0); $mform->addHelpButton('enrolstartdate', 'enrolstartdate', 'enrol_lti'); $mform->addElement('date_time_selector', 'enrolenddate', get_string('enrolenddate', 'enrol_lti'), array('optional' => true)); $mform->setDefault('enrolenddate', 0); $mform->addHelpButton('enrolenddate', 'enrolenddate', 'enrol_lti'); $mform->addElement('text', 'maxenrolled', get_string('maxenrolled', 'enrol_lti')); $mform->setDefault('maxenrolled', 0); $mform->addHelpButton('maxenrolled', 'maxenrolled', 'enrol_lti'); $mform->setType('maxenrolled', PARAM_INT); $assignableroles = get_assignable_roles($context); $mform->addElement('select', 'roleinstructor', get_string('roleinstructor', 'enrol_lti'), $assignableroles); $mform->setDefault('roleinstructor', '3'); $mform->addHelpButton('roleinstructor', 'roleinstructor', 'enrol_lti'); $mform->addElement('select', 'rolelearner', get_string('rolelearner', 'enrol_lti'), $assignableroles); $mform->setDefault('rolelearner', '5'); $mform->addHelpButton('rolelearner', 'rolelearner', 'enrol_lti');
> if (!$legacy) { $mform->addElement('header', 'remotesystem', get_string('remotesystem', 'enrol_lti')); > global $CFG; > require_once($CFG->dirroot . '/auth/lti/auth.php'); $mform->addElement('text', 'secret', get_string('secret', 'enrol_lti'), 'maxlength="64" size="25"'); > $authmodes = [ $mform->setType('secret', PARAM_ALPHANUM); > auth_plugin_lti::PROVISIONING_MODE_AUTO_ONLY => get_string('provisioningmodeauto', 'auth_lti'), $mform->setDefault('secret', random_string(32)); > auth_plugin_lti::PROVISIONING_MODE_PROMPT_NEW_EXISTING => get_string('provisioningmodenewexisting', 'auth_lti'), $mform->addHelpButton('secret', 'secret', 'enrol_lti'); > auth_plugin_lti::PROVISIONING_MODE_PROMPT_EXISTING_ONLY => get_string('provisioningmodeexistingonly', 'auth_lti') $mform->addRule('secret', get_string('required'), 'required'); > ]; > $mform->addElement('select', 'provisioningmodeinstructor', get_string('provisioningmodeteacherlaunch', 'enrol_lti'), $mform->addElement('selectyesno', 'gradesync', get_string('gradesync', 'enrol_lti')); > $authmodes); $mform->setDefault('gradesync', 1); > $mform->addHelpButton('provisioningmodeinstructor', 'provisioningmode', 'enrol_lti'); $mform->addHelpButton('gradesync', 'gradesync', 'enrol_lti'); > $mform->setDefault('provisioningmodeinstructor', auth_plugin_lti::PROVISIONING_MODE_PROMPT_NEW_EXISTING); > $mform->addElement('selectyesno', 'gradesynccompletion', get_string('requirecompletion', 'enrol_lti')); > $mform->addElement('select', 'provisioningmodelearner', get_string('provisioningmodestudentlaunch', 'enrol_lti'), $mform->setDefault('gradesynccompletion', 0); > $authmodes); $mform->disabledIf('gradesynccompletion', 'gradesync', 0); > $mform->addHelpButton('provisioningmodelearner', 'provisioningmode', 'enrol_lti'); > $mform->setDefault('provisioningmodelearner', auth_plugin_lti::PROVISIONING_MODE_AUTO_ONLY); $mform->addElement('selectyesno', 'membersync', get_string('membersync', 'enrol_lti')); > } $mform->setDefault('membersync', 1); >
< $mform->addRule('secret', get_string('required'), 'required');
> $mform->hideIf('secret', 'ltiversion', 'eq', 'LTI-1p3');
$options = array(); $options[\enrol_lti\helper::MEMBER_SYNC_ENROL_AND_UNENROL] = get_string('membersyncmodeenrolandunenrol', 'enrol_lti'); $options[\enrol_lti\helper::MEMBER_SYNC_ENROL_NEW] = get_string('membersyncmodeenrolnew', 'enrol_lti'); $options[\enrol_lti\helper::MEMBER_SYNC_UNENROL_MISSING] = get_string('membersyncmodeunenrolmissing', 'enrol_lti'); $mform->addElement('select', 'membersyncmode', get_string('membersyncmode', 'enrol_lti'), $options); $mform->setDefault('membersyncmode', \enrol_lti\helper::MEMBER_SYNC_ENROL_AND_UNENROL); $mform->addHelpButton('membersyncmode', 'membersyncmode', 'enrol_lti'); $mform->disabledIf('membersyncmode', 'membersync', 0); $mform->addElement('header', 'defaultheader', get_string('userdefaultvalues', 'enrol_lti')); $emaildisplay = get_config('enrol_lti', 'emaildisplay'); $choices = array( 0 => get_string('emaildisplayno'), 1 => get_string('emaildisplayyes'), 2 => get_string('emaildisplaycourse') ); $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices); $mform->setDefault('maildisplay', $emaildisplay); $mform->addHelpButton('maildisplay', 'emaildisplay'); $city = get_config('enrol_lti', 'city'); $mform->addElement('text', 'city', get_string('city'), 'maxlength="100" size="25"'); $mform->setType('city', PARAM_TEXT); $mform->setDefault('city', $city); $country = get_config('enrol_lti', 'country'); $countries = array('' => get_string('selectacountry') . '...') + get_string_manager()->get_list_of_countries(); $mform->addElement('select', 'country', get_string('selectacountry'), $countries); $mform->setDefault('country', $country); $mform->setAdvanced('country'); $timezone = get_config('enrol_lti', 'timezone'); $choices = core_date::get_list_of_timezones(null, true); $mform->addElement('select', 'timezone', get_string('timezone'), $choices); $mform->setDefault('timezone', $timezone); $mform->setAdvanced('timezone'); $lang = get_config('enrol_lti', 'lang'); $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations()); $mform->setDefault('lang', $lang); $mform->setAdvanced('lang'); $institution = get_config('enrol_lti', 'institution'); $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="40" size="25"'); $mform->setType('institution', core_user::get_property_type('institution')); $mform->setDefault('institution', $institution); $mform->setAdvanced('institution'); // Check if we are editing an instance. if (!empty($instance->id)) { // Get the details from the enrol_lti_tools table. $ltitool = $DB->get_record('enrol_lti_tools', array('enrolid' => $instance->id), '*', MUST_EXIST); $mform->addElement('hidden', 'toolid'); $mform->setType('toolid', PARAM_INT); $mform->setConstant('toolid', $ltitool->id);
> $mform->addElement('hidden', 'uuid'); $mform->setDefaults((array) $ltitool); > $mform->setType('uuid', PARAM_ALPHANUMEXT); } > $mform->setConstant('uuid', $ltitool->uuid); } >
/** * Perform custom validation of the data used to edit the instance. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @param object $instance The instance loaded from the DB * @param context $context The context of the instance we are editing * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK. * @return void */ public function edit_instance_validation($data, $files, $instance, $context) { global $COURSE, $DB; $errors = array();
> // Secret must be set. if (!empty($data['enrolenddate']) && $data['enrolenddate'] < $data['enrolstartdate']) { > if (empty($data['secret'])) { $errors['enrolenddate'] = get_string('enrolenddateerror', 'enrol_lti'); > $errors['secret'] = get_string('required'); } > } >
if (!empty($data['requirecompletion'])) { $completion = new completion_info($COURSE); $moodlecontext = $DB->get_record('context', array('id' => $data['contextid'])); if ($moodlecontext->contextlevel == CONTEXT_MODULE) { $cm = get_coursemodule_from_id(false, $moodlecontext->instanceid, 0, false, MUST_EXIST); } else { $cm = null; } if (!$completion->is_enabled($cm)) { $errors['requirecompletion'] = get_string('errorcompletionenabled', 'enrol_lti'); } } return $errors; } /** * Restore instance and map settings. * * @param restore_enrolments_structure_step $step * @param stdClass $data * @param stdClass $course * @param int $oldid */ public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) { // We want to call the parent because we do not want to add an enrol_lti_tools row // as that is done as part of the restore process. $instanceid = parent::add_instance($course, (array)$data); $step->set_mapping('enrol', $oldid, $instanceid); } } /** * Display the LTI link in the course administration menu. * * @param settings_navigation $navigation The settings navigation object * @param stdClass $course The course * @param stdclass $context Course context */ function enrol_lti_extend_navigation_course($navigation, $course, $context) { // Check that the LTI plugin is enabled. if (enrol_is_enabled('lti')) { // Check that they can add an instance. $ltiplugin = enrol_get_plugin('lti'); if ($ltiplugin->can_add_instance($course->id)) {
< $url = new moodle_url('/enrol/lti/index.php', array('courseid' => $course->id));
> $url = new moodle_url('/enrol/lti/index.php', ['courseid' => $course->id]);
$settingsnode = navigation_node::create(get_string('sharedexternaltools', 'enrol_lti'), $url,
< navigation_node::TYPE_SETTING, null, null, new pix_icon('i/settings', '')); <
> navigation_node::TYPE_SETTING, null, 'publishedtools', new pix_icon('i/settings', ''));
$navigation->add_node($settingsnode); } }
> } } > > /** > * Get icon mapping for font-awesome. > */ > function enrol_lti_get_fontawesome_icon_map() { > return [ > 'enrol_lti:managedeployments' => 'fa-sitemap', > 'enrol_lti:platformdetails' => 'fa-pencil-square-o', > 'enrol_lti:enrolinstancewarning' => 'fa-exclamation-circle text-danger', > ]; > } > > /** > * Pre-delete course module hook which disables any methods referring to the deleted module, preventing launches and allowing remap. > * > * @param stdClass $cm The deleted course module record. > */ > function enrol_lti_pre_course_module_delete(stdClass $cm) { > global $DB; > $sql = "id IN (SELECT t.enrolid > FROM {enrol_lti_tools} t > JOIN {context} c ON (t.contextid = c.id) > WHERE c.contextlevel = :contextlevel > AND c.instanceid = :cmid)"; > $DB->set_field_select('enrol', 'status', ENROL_INSTANCE_DISABLED, $sql, ['contextlevel' => CONTEXT_MODULE, 'cmid' => $cm->id]);