mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 08:56:36 +02:00
793aa03598
* When a label is passed to an (advanced) checkbox and no text was provided, the label will be displayed on the right of the the checkbox element. So there's no point in passing an empty string for the label just to render the text to the right of the checkbox.
393 lines
19 KiB
PHP
393 lines
19 KiB
PHP
<?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 defines de main basiclti configuration form
|
|
*
|
|
* @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
|
|
* @author Charles Severance
|
|
* @author Chris Scribner
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
global $CFG;
|
|
require_once($CFG->libdir.'/formslib.php');
|
|
require_once($CFG->dirroot.'/mod/lti/locallib.php');
|
|
|
|
/**
|
|
* LTI Edit Form
|
|
*
|
|
* @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
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class mod_lti_edit_types_form extends moodleform {
|
|
|
|
/**
|
|
* Define this form.
|
|
*/
|
|
public function definition() {
|
|
global $CFG, $PAGE;
|
|
|
|
$mform =& $this->_form;
|
|
|
|
$istool = $this->_customdata && isset($this->_customdata->istool) && $this->_customdata->istool;
|
|
$typeid = $this->_customdata->id ?? '';
|
|
$clientid = $this->_customdata->clientid ?? '';
|
|
|
|
// Add basiclti elements.
|
|
$mform->addElement('header', 'setup', get_string('tool_settings', 'lti'));
|
|
|
|
$mform->addElement('text', 'lti_typename', get_string('typename', 'lti'));
|
|
$mform->setType('lti_typename', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_typename', 'typename', 'lti');
|
|
$mform->addRule('lti_typename', null, 'required', null, 'client');
|
|
|
|
$mform->addElement('text', 'lti_toolurl', get_string('toolurl', 'lti'), array('size' => '64'));
|
|
$mform->setType('lti_toolurl', PARAM_URL);
|
|
$mform->addHelpButton('lti_toolurl', 'toolurl', 'lti');
|
|
|
|
$mform->addElement('textarea', 'lti_description', get_string('tooldescription', 'lti'), array('rows' => 4, 'cols' => 60));
|
|
$mform->setType('lti_description', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_description', 'tooldescription', 'lti');
|
|
if (!$istool) {
|
|
$mform->addRule('lti_toolurl', null, 'required', null, 'client');
|
|
} else {
|
|
$mform->disabledIf('lti_toolurl', null);
|
|
}
|
|
|
|
if (!$istool) {
|
|
$options = array(
|
|
LTI_VERSION_1 => get_string('oauthsecurity', 'lti'),
|
|
LTI_VERSION_1P3 => get_string('jwtsecurity', 'lti'),
|
|
);
|
|
$mform->addElement('select', 'lti_ltiversion', get_string('ltiversion', 'lti'), $options);
|
|
$mform->setType('lti_ltiversion', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_ltiversion', 'ltiversion', 'lti');
|
|
$mform->setDefault('lti_ltiversion', LTI_VERSION_1);
|
|
|
|
$mform->addElement('text', 'lti_resourcekey', get_string('resourcekey_admin', 'lti'));
|
|
$mform->setType('lti_resourcekey', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_resourcekey', 'resourcekey_admin', 'lti');
|
|
$mform->hideIf('lti_resourcekey', 'lti_ltiversion', 'eq', LTI_VERSION_1P3);
|
|
$mform->setForceLtr('lti_resourcekey');
|
|
|
|
$mform->addElement('passwordunmask', 'lti_password', get_string('password_admin', 'lti'));
|
|
$mform->setType('lti_password', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_password', 'password_admin', 'lti');
|
|
$mform->hideIf('lti_password', 'lti_ltiversion', 'eq', LTI_VERSION_1P3);
|
|
|
|
if (!empty($typeid)) {
|
|
$mform->addElement('text', 'lti_clientid_disabled', get_string('clientidadmin', 'lti'));
|
|
$mform->setType('lti_clientid_disabled', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_clientid_disabled', 'clientidadmin', 'lti');
|
|
$mform->hideIf('lti_clientid_disabled', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
|
|
$mform->disabledIf('lti_clientid_disabled', null);
|
|
$mform->setForceLtr('lti_clientid_disabled');
|
|
$mform->addElement('hidden', 'lti_clientid');
|
|
$mform->setType('lti_clientid', PARAM_TEXT);
|
|
}
|
|
|
|
$keyoptions = [
|
|
LTI_RSA_KEY => get_string('keytype_rsa', 'lti'),
|
|
LTI_JWK_KEYSET => get_string('keytype_keyset', 'lti'),
|
|
];
|
|
$mform->addElement('select', 'lti_keytype', get_string('keytype', 'lti'), $keyoptions);
|
|
$mform->setType('lti_keytype', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_keytype', 'keytype', 'lti');
|
|
$mform->setDefault('lti_keytype', LTI_JWK_KEYSET);
|
|
$mform->hideIf('lti_keytype', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
|
|
|
|
$mform->addElement('textarea', 'lti_publickey', get_string('publickey', 'lti'), ['rows' => 8, 'cols' => 60]);
|
|
$mform->setType('lti_publickey', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_publickey', 'publickey', 'lti');
|
|
$mform->hideIf('lti_publickey', 'lti_keytype', 'neq', LTI_RSA_KEY);
|
|
$mform->hideIf('lti_publickey', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
|
|
$mform->setForceLtr('lti_publickey');
|
|
|
|
$mform->addElement('text', 'lti_publickeyset', get_string('publickeyset', 'lti'), ['size' => '64']);
|
|
$mform->setType('lti_publickeyset', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_publickeyset', 'publickeyset', 'lti');
|
|
$mform->hideIf('lti_publickeyset', 'lti_keytype', 'neq', LTI_JWK_KEYSET);
|
|
$mform->hideIf('lti_publickeyset', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
|
|
$mform->setForceLtr('lti_publickeyset');
|
|
|
|
$mform->addElement('text', 'lti_initiatelogin', get_string('initiatelogin', 'lti'), array('size' => '64'));
|
|
$mform->setType('lti_initiatelogin', PARAM_URL);
|
|
$mform->addHelpButton('lti_initiatelogin', 'initiatelogin', 'lti');
|
|
$mform->hideIf('lti_initiatelogin', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
|
|
|
|
$mform->addElement('textarea', 'lti_redirectionuris', get_string('redirectionuris', 'lti'),
|
|
array('rows' => 3, 'cols' => 60));
|
|
$mform->setType('lti_redirectionuris', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_redirectionuris', 'redirectionuris', 'lti');
|
|
$mform->hideIf('lti_redirectionuris', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
|
|
$mform->setForceLtr('lti_redirectionuris');
|
|
}
|
|
|
|
if ($istool) {
|
|
$mform->addElement('textarea', 'lti_parameters', get_string('parameter', 'lti'), array('rows' => 4, 'cols' => 60));
|
|
$mform->setType('lti_parameters', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_parameters', 'parameter', 'lti');
|
|
$mform->disabledIf('lti_parameters', null);
|
|
$mform->setForceLtr('lti_parameters');
|
|
}
|
|
|
|
$mform->addElement('textarea', 'lti_customparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
|
|
$mform->setType('lti_customparameters', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_customparameters', 'custom', 'lti');
|
|
$mform->setForceLtr('lti_customparameters');
|
|
|
|
if (!empty($this->_customdata->isadmin)) {
|
|
$options = array(
|
|
LTI_COURSEVISIBLE_NO => get_string('show_in_course_no', 'lti'),
|
|
LTI_COURSEVISIBLE_PRECONFIGURED => get_string('show_in_course_preconfigured', 'lti'),
|
|
LTI_COURSEVISIBLE_ACTIVITYCHOOSER => get_string('show_in_course_activity_chooser', 'lti'),
|
|
);
|
|
if ($istool) {
|
|
// LTI2 tools can not be matched by URL, they have to be either in preconfigured tools or in activity chooser.
|
|
unset($options[LTI_COURSEVISIBLE_NO]);
|
|
$stringname = 'show_in_course_lti2';
|
|
} else {
|
|
$stringname = 'show_in_course_lti1';
|
|
}
|
|
$mform->addElement('select', 'lti_coursevisible', get_string($stringname, 'lti'), $options);
|
|
$mform->addHelpButton('lti_coursevisible', $stringname, 'lti');
|
|
$mform->setDefault('lti_coursevisible', '1');
|
|
} else {
|
|
$mform->addElement('hidden', 'lti_coursevisible', LTI_COURSEVISIBLE_PRECONFIGURED);
|
|
}
|
|
$mform->setType('lti_coursevisible', PARAM_INT);
|
|
|
|
$mform->addElement('hidden', 'typeid');
|
|
$mform->setType('typeid', PARAM_INT);
|
|
|
|
$launchoptions = array();
|
|
$launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
|
|
$launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
|
|
$launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
|
|
$launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
|
|
|
|
$mform->addElement('select', 'lti_launchcontainer', get_string('default_launch_container', 'lti'), $launchoptions);
|
|
$mform->setDefault('lti_launchcontainer', LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS);
|
|
$mform->addHelpButton('lti_launchcontainer', 'default_launch_container', 'lti');
|
|
$mform->setType('lti_launchcontainer', PARAM_INT);
|
|
|
|
$mform->addElement('advcheckbox', 'lti_contentitem', get_string('contentitem_deeplinking', 'lti'));
|
|
$mform->addHelpButton('lti_contentitem', 'contentitem_deeplinking', 'lti');
|
|
if ($istool) {
|
|
$mform->disabledIf('lti_contentitem', null);
|
|
}
|
|
|
|
$mform->addElement('text', 'lti_toolurl_ContentItemSelectionRequest',
|
|
get_string('toolurl_contentitemselectionrequest', 'lti'), array('size' => '64'));
|
|
$mform->setType('lti_toolurl_ContentItemSelectionRequest', PARAM_URL);
|
|
$mform->addHelpButton('lti_toolurl_ContentItemSelectionRequest', 'toolurl_contentitemselectionrequest', 'lti');
|
|
$mform->disabledIf('lti_toolurl_ContentItemSelectionRequest', 'lti_contentitem', 'notchecked');
|
|
if ($istool) {
|
|
$mform->disabledIf('lti_toolurl__ContentItemSelectionRequest', null);
|
|
}
|
|
|
|
$mform->addElement('hidden', 'oldicon');
|
|
$mform->setType('oldicon', PARAM_URL);
|
|
|
|
$mform->addElement('text', 'lti_icon', get_string('icon_url', 'lti'), array('size' => '64'));
|
|
$mform->setType('lti_icon', PARAM_URL);
|
|
$mform->setAdvanced('lti_icon');
|
|
$mform->addHelpButton('lti_icon', 'icon_url', 'lti');
|
|
|
|
$mform->addElement('text', 'lti_secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
|
|
$mform->setType('lti_secureicon', PARAM_URL);
|
|
$mform->setAdvanced('lti_secureicon');
|
|
$mform->addHelpButton('lti_secureicon', 'secure_icon_url', 'lti');
|
|
|
|
if (!$istool) {
|
|
// Display the lti advantage services.
|
|
$this->get_lti_advantage_services($mform);
|
|
}
|
|
|
|
if (!$istool) {
|
|
// Add privacy preferences fieldset where users choose whether to send their data.
|
|
$mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
|
|
|
|
$options = array();
|
|
$options[0] = get_string('never', 'lti');
|
|
$options[1] = get_string('always', 'lti');
|
|
$options[2] = get_string('delegate', 'lti');
|
|
|
|
$mform->addElement('select', 'lti_sendname', get_string('share_name_admin', 'lti'), $options);
|
|
$mform->setType('lti_sendname', PARAM_INT);
|
|
$mform->setDefault('lti_sendname', '2');
|
|
$mform->addHelpButton('lti_sendname', 'share_name_admin', 'lti');
|
|
|
|
$mform->addElement('select', 'lti_sendemailaddr', get_string('share_email_admin', 'lti'), $options);
|
|
$mform->setType('lti_sendemailaddr', PARAM_INT);
|
|
$mform->setDefault('lti_sendemailaddr', '2');
|
|
$mform->addHelpButton('lti_sendemailaddr', 'share_email_admin', 'lti');
|
|
|
|
// LTI Extensions.
|
|
|
|
// Add grading preferences fieldset where the tool is allowed to return grades.
|
|
$gradeoptions = array();
|
|
$gradeoptions[] = get_string('never', 'lti');
|
|
$gradeoptions[] = get_string('always', 'lti');
|
|
$gradeoptions[] = get_string('delegate_tool', 'lti');
|
|
|
|
$mform->addElement('select', 'lti_acceptgrades', get_string('accept_grades_admin', 'lti'), $gradeoptions);
|
|
$mform->setType('lti_acceptgrades', PARAM_INT);
|
|
$mform->setDefault('lti_acceptgrades', '2');
|
|
$mform->addHelpButton('lti_acceptgrades', 'accept_grades_admin', 'lti');
|
|
|
|
$mform->addElement('checkbox', 'lti_forcessl', get_string('force_ssl', 'lti'), '', $options);
|
|
$mform->setType('lti_forcessl', PARAM_BOOL);
|
|
if (!empty($CFG->mod_lti_forcessl)) {
|
|
$mform->setDefault('lti_forcessl', '1');
|
|
$mform->freeze('lti_forcessl');
|
|
} else {
|
|
$mform->setDefault('lti_forcessl', '0');
|
|
}
|
|
$mform->addHelpButton('lti_forcessl', 'force_ssl', 'lti');
|
|
|
|
if (!empty($this->_customdata->isadmin)) {
|
|
// Add setup parameters fieldset.
|
|
$mform->addElement('header', 'setupoptions', get_string('miscellaneous', 'lti'));
|
|
|
|
$options = array(
|
|
LTI_DEFAULT_ORGID_SITEID => get_string('siteid', 'lti'),
|
|
LTI_DEFAULT_ORGID_SITEHOST => get_string('sitehost', 'lti'),
|
|
);
|
|
|
|
$mform->addElement('select', 'lti_organizationid_default', get_string('organizationid_default', 'lti'), $options);
|
|
$mform->setType('lti_organizationid_default', PARAM_TEXT);
|
|
$mform->setDefault('lti_organizationid_default', LTI_DEFAULT_ORGID_SITEID);
|
|
$mform->addHelpButton('lti_organizationid_default', 'organizationid_default', 'lti');
|
|
|
|
$mform->addElement('text', 'lti_organizationid', get_string('organizationidguid', 'lti'));
|
|
$mform->setType('lti_organizationid', PARAM_TEXT);
|
|
$mform->addHelpButton('lti_organizationid', 'organizationidguid', 'lti');
|
|
|
|
$mform->addElement('text', 'lti_organizationurl', get_string('organizationurl', 'lti'));
|
|
$mform->setType('lti_organizationurl', PARAM_URL);
|
|
$mform->addHelpButton('lti_organizationurl', 'organizationurl', 'lti');
|
|
}
|
|
}
|
|
|
|
/* Suppress this for now - Chuck
|
|
* mform->addElement('text', 'lti_organizationdescr', get_string('organizationdescr', 'lti'))
|
|
* mform->setType('lti_organizationdescr', PARAM_TEXT)
|
|
* mform->addHelpButton('lti_organizationdescr', 'organizationdescr', 'lti')
|
|
*/
|
|
|
|
/*
|
|
// Add a hidden element to signal a tool fixing operation after a problematic backup - restore process
|
|
//$mform->addElement('hidden', 'lti_fix');
|
|
*/
|
|
|
|
$tab = optional_param('tab', '', PARAM_ALPHAEXT);
|
|
$mform->addElement('hidden', 'tab', $tab);
|
|
$mform->setType('tab', PARAM_ALPHAEXT);
|
|
|
|
$courseid = optional_param('course', 1, PARAM_INT);
|
|
$mform->addElement('hidden', 'course', $courseid);
|
|
$mform->setType('course', PARAM_INT);
|
|
|
|
// Add standard buttons, common to all modules.
|
|
$this->add_action_buttons();
|
|
|
|
}
|
|
|
|
/**
|
|
* Retrieves the data of the submitted form.
|
|
*
|
|
* @return stdClass
|
|
*/
|
|
public function get_data() {
|
|
$data = parent::get_data();
|
|
if ($data && !empty($this->_customdata->istool)) {
|
|
// Content item checkbox is disabled in tool settings, so this cannot be edited. Just unset it.
|
|
unset($data->lti_contentitem);
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Generates the lti advantage extra configuration adding it to the mform
|
|
*
|
|
* @param MoodleQuickForm $mform
|
|
*/
|
|
public function get_lti_advantage_services(&$mform) {
|
|
// For each service add the label and get the array of configuration.
|
|
$services = lti_get_services();
|
|
$mform->addElement('header', 'services', get_string('services', 'lti'));
|
|
foreach ($services as $service) {
|
|
/** @var \mod_lti\local\ltiservice\service_base $service */
|
|
$service->get_configuration_options($mform);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Validate the form data before we allow them to save the tool type.
|
|
*
|
|
* @param array $data
|
|
* @param array $files
|
|
* @return array Error messages
|
|
*/
|
|
public function validation($data, $files) {
|
|
global $CFG;
|
|
|
|
$errors = parent::validation($data, $files);
|
|
|
|
// LTI2 tools do not contain a ltiversion field.
|
|
if (isset($data['lti_ltiversion']) && $data['lti_ltiversion'] == LTI_VERSION_1P3) {
|
|
require_once($CFG->dirroot . '/mod/lti/upgradelib.php');
|
|
|
|
$warning = mod_lti_verify_private_key();
|
|
if (!empty($warning)) {
|
|
$errors['lti_ltiversion'] = $warning;
|
|
return $errors;
|
|
}
|
|
}
|
|
return $errors;
|
|
}
|
|
}
|