mod/lti/mod_form.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16 //
  17 // This file is part of BasicLTI4Moodle
  18 //
  19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
  20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
  21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
  22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
  23 // are already supporting or going to support BasicLTI. This project Implements the consumer
  24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
  25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
  26 // at the GESSI research group at UPC.
  27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
  28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
  29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
  30 //
  31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
  32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
  33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
  34
  35 /**
  36  * This file defines the main lti configuration form
  37  *
  38  * @package mod_lti
  39  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  40  *  marc.alier@upc.edu
  41  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  42  * @author     Marc Alier
  43  * @author     Jordi Piguillem
  44  * @author     Nikolas Galanis
  45  * @author     Chris Scribner
  46  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  47  */
  48
  49 defined('MOODLE_INTERNAL') || die;
  50
  51 require_once($CFG->dirroot.'/course/moodleform_mod.php');
  52 require_once($CFG->dirroot.'/mod/lti/locallib.php');
  53
  54 class mod_lti_mod_form extends moodleform_mod {
  55
  56     public function definition() {
  57         global $PAGE, $OUTPUT, $COURSE;
  58
  59         if ($type = optional_param('type', false, PARAM_ALPHA)) {
  60             component_callback("ltisource_$type", 'add_instance_hook');
  61         }
  62
  63         $this->typeid = 0;
  64
  65         $mform =& $this->_form;
  66         // Adding the "general" fieldset, where all the common settings are shown.
  67         $mform->addElement('header', 'general', get_string('general', 'form'));
  68         // Adding the standard "name" field.
  69         $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size' => '64'));
  70         $mform->setType('name', PARAM_TEXT);
  71         $mform->addRule('name', null, 'required', null, 'client');
  72         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  73         // Adding the optional "intro" and "introformat" pair of fields.
  74         $this->standard_intro_elements(get_string('basicltiintro', 'lti'));
  75         $mform->setAdvanced('introeditor');
  76
  77         // Display the label to the right of the checkbox so it looks better & matches rest of the form.
  78         if ($mform->elementExists('showdescription')) {
  79             $coursedesc = $mform->getElement('showdescription');
  80             if (!empty($coursedesc)) {
  81                 $coursedesc->setText(' ' . $coursedesc->getLabel());
  82                 $coursedesc->setLabel('&nbsp');
  83             }
  84         }
  85
  86         $mform->setAdvanced('showdescription');
  87
  88         $mform->addElement('checkbox', 'showtitlelaunch', '&nbsp;', ' ' . get_string('display_name', 'lti'));
  89         $mform->setAdvanced('showtitlelaunch');
  90         $mform->setDefault('showtitlelaunch', true);
  91         $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
  92
  93         $mform->addElement('checkbox', 'showdescriptionlaunch', '&nbsp;', ' ' . get_string('display_description', 'lti'));
  94         $mform->setAdvanced('showdescriptionlaunch');
  95         $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
  96
  97         // Tool settings.
  98         $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'));
  99         // Type ID parameter being passed when adding an preconfigured tool from activity chooser.
 100         $typeid = optional_param('typeid', false, PARAM_INT);
 101         if ($typeid) {
 102             $mform->getElement('typeid')->setValue($typeid);
 103         }
 104         $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
 105         $toolproxy = array();
 106
 107         // Array of tool type IDs that don't support ContentItemSelectionRequest.
 108         $noncontentitemtypes = [];
 109
 110         foreach (lti_get_types_for_add_instance() as $id => $type) {
 111             if (!empty($type->toolproxyid)) {
 112                 $toolproxy[] = $type->id;
 113                 $attributes = array( 'globalTool' => 1, 'toolproxy' => 1);
 114                 $enabledcapabilities = explode("\n", $type->enabledcapability);
 115                 if (!in_array('Result.autocreate', $enabledcapabilities)) {
 116                     $attributes['nogrades'] = 1;
 117                 }
 118                 if (!in_array('Person.name.full', $enabledcapabilities) && !in_array('Person.name.family', $enabledcapabilities) &&
 119                     !in_array('Person.name.given', $enabledcapabilities)) {
 120                     $attributes['noname'] = 1;
 121                 }
 122                 if (!in_array('Person.email.primary', $enabledcapabilities)) {
 123                     $attributes['noemail'] = 1;
 124                 }
 125             } else if ($type->course == $COURSE->id) {
 126                 $attributes = array( 'editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain );
 127             } else if ($id != 0) {
 128                 $attributes = array( 'globalTool' => 1, 'domain' => $type->tooldomain);
 129             } else {
 130                 $attributes = array();
 131             }
 132
 133             if ($id) {
 134                 $config = lti_get_type_config($id);
 135                 if (!empty($config['contentitem'])) {
 136                     $attributes['data-contentitem'] = 1;
 137                     $attributes['data-id'] = $id;
 138                 } else {
 139                     $noncontentitemtypes[] = $id;
 140                 }
 141             }
 142             $tooltypes->addOption($type->name, $id, $attributes);
 143         }
 144
 145         // Add button that launches the content-item selection dialogue.
 146         // Set contentitem URL.
 147         $contentitemurl = new moodle_url('/mod/lti/contentitem.php');
 148         $contentbuttonattributes = [
 149             'data-contentitemurl' => $contentitemurl->out(false)
 150         ];
 151         $contentbuttonlabel = get_string('selectcontent', 'lti');
 152         $contentbutton = $mform->addElement('button', 'selectcontent', $contentbuttonlabel, $contentbuttonattributes);
 153         // Disable select content button if the selected tool doesn't support content item or it's set to Automatic.
 154         $allnoncontentitemtypes = $noncontentitemtypes;
 155         $allnoncontentitemtypes[] = '0'; // Add option value for "Automatic, based on tool URL".
 156         $mform->disabledIf('selectcontent', 'typeid', 'in', $allnoncontentitemtypes);
 157
 158         $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size' => '64'));
 159         $mform->setType('toolurl', PARAM_URL);
 160         $mform->addHelpButton('toolurl', 'launch_url', 'lti');
 161         $mform->disabledIf('toolurl', 'typeid', 'in', $noncontentitemtypes);
 162
 163         $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size' => '64'));
 164         $mform->setType('securetoolurl', PARAM_URL);
 165         $mform->setAdvanced('securetoolurl');
 166         $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
 167         $mform->disabledIf('securetoolurl', 'typeid', 'in', $noncontentitemtypes);
 168
 169         $mform->addElement('hidden', 'urlmatchedtypeid', '', array( 'id' => 'id_urlmatchedtypeid' ));
 170         $mform->setType('urlmatchedtypeid', PARAM_INT);
 171
 172         $launchoptions = array();
 173         $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
 174         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
 175         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
 176         $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
 177         $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
 178
 179         $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
 180         $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
 181         $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
 182         $mform->setAdvanced('launchcontainer');
 183
 184         $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
 185         $mform->setType('resourcekey', PARAM_TEXT);
 186         $mform->setAdvanced('resourcekey');
 187         $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
 188         $mform->setForceLtr('resourcekey');
 189         $mform->disabledIf('resourcekey', 'typeid', 'in', $noncontentitemtypes);
 190
 191         $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
 192         $mform->setType('password', PARAM_TEXT);
 193         $mform->setAdvanced('password');
 194         $mform->addHelpButton('password', 'password', 'lti');
 195         $mform->disabledIf('password', 'typeid', 'in', $noncontentitemtypes);
 196
 197         $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
 198         $mform->setType('instructorcustomparameters', PARAM_TEXT);
 199         $mform->setAdvanced('instructorcustomparameters');
 200         $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
 201         $mform->setForceLtr('instructorcustomparameters');
 202
 203         $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size' => '64'));
 204         $mform->setType('icon', PARAM_URL);
 205         $mform->setAdvanced('icon');
 206         $mform->addHelpButton('icon', 'icon_url', 'lti');
 207         $mform->disabledIf('icon', 'typeid', 'in', $noncontentitemtypes);
 208
 209         $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
 210         $mform->setType('secureicon', PARAM_URL);
 211         $mform->setAdvanced('secureicon');
 212         $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
 213         $mform->disabledIf('secureicon', 'typeid', 'in', $noncontentitemtypes);
 214
 215         // Add privacy preferences fieldset where users choose whether to send their data.
 216         $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
 217
 218         $mform->addElement('advcheckbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
 219         $mform->setDefault('instructorchoicesendname', '1');
 220         $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
 221         $mform->disabledIf('instructorchoicesendname', 'typeid', 'in', $toolproxy);
 222
 223         $mform->addElement('advcheckbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
 224         $mform->setDefault('instructorchoicesendemailaddr', '1');
 225         $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
 226         $mform->disabledIf('instructorchoicesendemailaddr', 'typeid', 'in', $toolproxy);
 227
 228         $mform->addElement('advcheckbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
 229         $mform->setDefault('instructorchoiceacceptgrades', '1');
 230         $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
 231         $mform->disabledIf('instructorchoiceacceptgrades', 'typeid', 'in', $toolproxy);
 232
 233         // Add standard course module grading elements.
 234         $this->standard_grading_coursemodule_elements();
 235
 236         // Add standard elements, common to all modules.
 237         $this->standard_coursemodule_elements();
 238         $mform->setAdvanced('cmidnumber');
 239
 240         // Add standard buttons, common to all modules.
 241         $this->add_action_buttons();
 242
 243         $editurl = new moodle_url('/mod/lti/instructor_edit_tool_type.php',
 244                 array('sesskey' => sesskey(), 'course' => $COURSE->id));
 245         $ajaxurl = new moodle_url('/mod/lti/ajax.php');
 246
 247         // All these icon uses are incorrect. LTI JS needs updating to use AMD modules and templates so it can use
 248         // the mustache pix helper - until then LTI will have inconsistent icons.
 249         $jsinfo = (object)array(
 250                         'edit_icon_url' => (string)$OUTPUT->image_url('t/edit'),
 251                         'add_icon_url' => (string)$OUTPUT->image_url('t/add'),
 252                         'delete_icon_url' => (string)$OUTPUT->image_url('t/delete'),
 253                         'green_check_icon_url' => (string)$OUTPUT->image_url('i/valid'),
 254                         'warning_icon_url' => (string)$OUTPUT->image_url('warning', 'lti'),
 255                         'instructor_tool_type_edit_url' => $editurl->out(false),
 256                         'ajax_url' => $ajaxurl->out(true),
 257                         'courseId' => $COURSE->id
 258                   );
 259
 260         $module = array(
 261             'name' => 'mod_lti_edit',
 262             'fullpath' => '/mod/lti/mod_form.js',
 263             'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
 264             'strings' => array(
 265                 array('addtype', 'lti'),
 266                 array('edittype', 'lti'),
 267                 array('deletetype', 'lti'),
 268                 array('delete_confirmation', 'lti'),
 269                 array('cannot_edit', 'lti'),
 270                 array('cannot_delete', 'lti'),
 271                 array('global_tool_types', 'lti'),
 272                 array('course_tool_types', 'lti'),
 273                 array('using_tool_configuration', 'lti'),
 274                 array('using_tool_cartridge', 'lti'),
 275                 array('domain_mismatch', 'lti'),
 276                 array('custom_config', 'lti'),
 277                 array('tool_config_not_found', 'lti'),
 278                 array('tooltypeadded', 'lti'),
 279                 array('tooltypedeleted', 'lti'),
 280                 array('tooltypenotdeleted', 'lti'),
 281                 array('tooltypeupdated', 'lti'),
 282                 array('forced_help', 'lti')
 283             ),
 284         );
 285
 286         if (!empty($typeid)) {
 287             $mform->setAdvanced('typeid');
 288             $mform->setAdvanced('toolurl');
 289         }
 290
 291         $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
 292     }
 293
 294 }