MDL-68328 mod_lti: use hidden form when deeplink options disabled
[moodle.git] / mod / lti / mod_form.php
CommitLineData
996b0fd9 1<?php
61eb12d4
CS
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//
996b0fd9
CS
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
e3f69b58 33// Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
996b0fd9
CS
34
35/**
61eb12d4 36 * This file defines the main lti configuration form
996b0fd9 37 *
2b17ec3d 38 * @package mod_lti
61eb12d4 39 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
996b0fd9 40 * marc.alier@upc.edu
61eb12d4
CS
41 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
42 * @author Marc Alier
43 * @author Jordi Piguillem
44 * @author Nikolas Galanis
8f45215d 45 * @author Chris Scribner
61eb12d4 46 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
996b0fd9
CS
47 */
48
49defined('MOODLE_INTERNAL') || die;
50
51require_once($CFG->dirroot.'/course/moodleform_mod.php');
52require_once($CFG->dirroot.'/mod/lti/locallib.php');
53
b1e9a121 54class mod_lti_mod_form extends moodleform_mod {
996b0fd9 55
ea04a9f9 56 public function definition() {
c1fae2b9 57 global $PAGE, $OUTPUT, $COURSE;
996b0fd9 58
976b5bca
CS
59 if ($type = optional_param('type', false, PARAM_ALPHA)) {
60 component_callback("ltisource_$type", 'add_instance_hook');
61 }
8cf7670e 62
477e8717
DS
63 // Type ID parameter being passed when adding an preconfigured tool from activity chooser.
64 $typeid = optional_param('typeid', false, PARAM_INT);
65
f259405d 66 $showoptions = has_capability('mod/lti:addmanualinstance', $this->context);
477e8717
DS
67 // Show configuration details only if not preset (when new) or user has the capabilities to do so (when editing).
68 if ($this->_instance) {
69 $showtypes = has_capability('mod/lti:addpreconfiguredinstance', $this->context);
477e8717
DS
70 if (!$showoptions && $this->current->typeid == 0) {
71 // If you cannot add a manual instance and this is already a manual instance, then
72 // remove the 'types' selector.
73 $showtypes = false;
74 }
75 } else {
76 $showtypes = !$typeid;
477e8717
DS
77 }
78
996b0fd9 79 $this->typeid = 0;
e27cb316 80
996b0fd9 81 $mform =& $this->_form;
e3f69b58 82 // Adding the "general" fieldset, where all the common settings are shown.
996b0fd9 83 $mform->addElement('header', 'general', get_string('general', 'form'));
e3f69b58 84 // Adding the standard "name" field.
85 $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size' => '64'));
996b0fd9
CS
86 $mform->setType('name', PARAM_TEXT);
87 $mform->addRule('name', null, 'required', null, 'client');
a74cd331 88 $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
e3f69b58 89 // Adding the optional "intro" and "introformat" pair of fields.
6398ff53 90 $this->standard_intro_elements(get_string('basicltiintro', 'lti'));
996b0fd9 91 $mform->setAdvanced('introeditor');
194f2c60 92
e3f69b58 93 // Display the label to the right of the checkbox so it looks better & matches rest of the form.
8b40604a 94 if ($mform->elementExists('showdescription')) {
7046798f
DM
95 $coursedesc = $mform->getElement('showdescription');
96 if (!empty($coursedesc)) {
97 $coursedesc->setText(' ' . $coursedesc->getLabel());
98 $coursedesc->setLabel('&nbsp');
99 }
b07878ec 100 }
194f2c60 101
b07878ec 102 $mform->setAdvanced('showdescription');
996b0fd9 103
b07878ec
CS
104 $mform->addElement('checkbox', 'showtitlelaunch', '&nbsp;', ' ' . get_string('display_name', 'lti'));
105 $mform->setAdvanced('showtitlelaunch');
80fd0072 106 $mform->setDefault('showtitlelaunch', true);
b07878ec 107 $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
e27cb316 108
b07878ec
CS
109 $mform->addElement('checkbox', 'showdescriptionlaunch', '&nbsp;', ' ' . get_string('display_description', 'lti'));
110 $mform->setAdvanced('showdescriptionlaunch');
111 $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
e27cb316 112
e3f69b58 113 // Tool settings.
e3f69b58 114 $toolproxy = array();
c1fae2b9 115 // Array of tool type IDs that don't support ContentItemSelectionRequest.
2d313053 116 $noncontentitemtypes = [];
c1fae2b9 117
477e8717
DS
118 if ($showtypes) {
119 $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'));
120 if ($typeid) {
121 $mform->getElement('typeid')->setValue($typeid);
996b0fd9 122 }
477e8717
DS
123 $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
124
125 foreach (lti_get_types_for_add_instance() as $id => $type) {
126 if (!empty($type->toolproxyid)) {
127 $toolproxy[] = $type->id;
128 $attributes = array('globalTool' => 1, 'toolproxy' => 1);
129 $enabledcapabilities = explode("\n", $type->enabledcapability);
130 if (!in_array('Result.autocreate', $enabledcapabilities) ||
131 in_array('BasicOutcome.url', $enabledcapabilities)) {
132 $attributes['nogrades'] = 1;
133 }
134 if (!in_array('Person.name.full', $enabledcapabilities) &&
135 !in_array('Person.name.family', $enabledcapabilities) &&
136 !in_array('Person.name.given', $enabledcapabilities)) {
137 $attributes['noname'] = 1;
138 }
139 if (!in_array('Person.email.primary', $enabledcapabilities)) {
140 $attributes['noemail'] = 1;
141 }
142 } else if ($type->course == $COURSE->id) {
143 $attributes = array('editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain);
144 } else if ($id != 0) {
145 $attributes = array('globalTool' => 1, 'domain' => $type->tooldomain);
c1fae2b9 146 } else {
477e8717 147 $attributes = array();
d8f9109a 148 }
477e8717
DS
149
150 if ($id) {
151 $config = lti_get_type_config($id);
152 if (!empty($config['contentitem'])) {
153 $attributes['data-contentitem'] = 1;
154 $attributes['data-id'] = $id;
155 } else {
156 $noncontentitemtypes[] = $id;
157 }
158 }
159 $tooltypes->addOption($type->name, $id, $attributes);
d8f9109a 160 }
477e8717
DS
161 } else {
162 $mform->addElement('hidden', 'typeid', $typeid);
163 $mform->setType('typeid', PARAM_INT);
b791ed15
DS
164 if ($typeid) {
165 $config = lti_get_type_config($typeid);
166 if (!empty($config['contentitem'])) {
167 $mform->addElement('hidden', 'contentitem', 1);
168 $mform->setType('contentitem', PARAM_INT);
169 }
170 }
996b0fd9 171 }
c1fae2b9 172
1b669ebe 173 // Add button that launches the content-item selection dialogue.
3a69044f
DS
174 // Set contentitem URL.
175 $contentitemurl = new moodle_url('/mod/lti/contentitem.php');
176 $contentbuttonattributes = [
177 'data-contentitemurl' => $contentitemurl->out(false)
178 ];
179 if (!$showtypes) {
180 if (!$typeid || empty(lti_get_type_config($typeid)['contentitem'])) {
181 $contentbuttonattributes['disabled'] = 'disabled';
182 }
183 }
184 $contentbuttonlabel = get_string('selectcontent', 'lti');
185 $contentbutton = $mform->addElement('button', 'selectcontent', $contentbuttonlabel, $contentbuttonattributes);
186 // Disable select content button if the selected tool doesn't support content item or it's set to Automatic.
187 if ($showtypes) {
477e8717
DS
188 $allnoncontentitemtypes = $noncontentitemtypes;
189 $allnoncontentitemtypes[] = '0'; // Add option value for "Automatic, based on tool URL".
190 $mform->disabledIf('selectcontent', 'typeid', 'in', $allnoncontentitemtypes);
3a69044f 191 }
477e8717 192
3a69044f 193 if ($showoptions) {
477e8717
DS
194 $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size' => '64'));
195 $mform->setType('toolurl', PARAM_URL);
196 $mform->addHelpButton('toolurl', 'launch_url', 'lti');
197 $mform->hideIf('toolurl', 'typeid', 'in', $noncontentitemtypes);
198
199 $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size' => '64'));
200 $mform->setType('securetoolurl', PARAM_URL);
201 $mform->setAdvanced('securetoolurl');
202 $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
203 $mform->hideIf('securetoolurl', 'typeid', 'in', $noncontentitemtypes);
f259405d
CV
204 } else {
205 // We still need those on page to support deep linking return, but hidden to avoid instructor modification.
206 $mform->addElement('hidden', 'toolurl', '', array('id' => 'id_toolurl'));
207 $mform->setType('toolurl', PARAM_URL);
208 $mform->addElement('hidden', 'securetoolurl', '', array('id' => 'id_securetoolurl'));
209 $mform->setType('securetoolurl', PARAM_URL);
477e8717 210 }
e27cb316 211
f259405d 212 $mform->addElement('hidden', 'urlmatchedtypeid', '', array('id' => 'id_urlmatchedtypeid'));
ea5d0515
AF
213 $mform->setType('urlmatchedtypeid', PARAM_INT);
214
3a69044f
DS
215 $launchoptions = array();
216 $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
217 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
218 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
219 $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
220 $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
477e8717 221
3a69044f
DS
222 $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
223 $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
224 $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
225 $mform->setAdvanced('launchcontainer');
226
227 if ($showoptions) {
477e8717
DS
228 $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
229 $mform->setType('resourcekey', PARAM_TEXT);
230 $mform->setAdvanced('resourcekey');
231 $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
232 $mform->setForceLtr('resourcekey');
233 $mform->hideIf('resourcekey', 'typeid', 'in', $noncontentitemtypes);
234
235 $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
236 $mform->setType('password', PARAM_TEXT);
237 $mform->setAdvanced('password');
238 $mform->addHelpButton('password', 'password', 'lti');
239 $mform->hideIf('password', 'typeid', 'in', $noncontentitemtypes);
240
241 $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
242 $mform->setType('instructorcustomparameters', PARAM_TEXT);
243 $mform->setAdvanced('instructorcustomparameters');
244 $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
245 $mform->setForceLtr('instructorcustomparameters');
246
247 $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size' => '64'));
248 $mform->setType('icon', PARAM_URL);
249 $mform->setAdvanced('icon');
250 $mform->addHelpButton('icon', 'icon_url', 'lti');
251 $mform->hideIf('icon', 'typeid', 'in', $noncontentitemtypes);
252
253 $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
254 $mform->setType('secureicon', PARAM_URL);
255 $mform->setAdvanced('secureicon');
256 $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
257 $mform->hideIf('secureicon', 'typeid', 'in', $noncontentitemtypes);
f259405d
CV
258 } else {
259 // Keep those in the form to allow deep linking, key and secret are removed altogether.
260 $mform->addElement('hidden', 'instructorcustomparameters', '', array('id' => 'id_instructorcustomparameters'));
261 $mform->setType('instructorcustomparameters', PARAM_TEXT);
262 $mform->addElement('hidden', 'icon', '', array('id' => 'id_icon'));
263 $mform->setType('icon', PARAM_URL);
264 $mform->addElement('hidden', 'secureicon', '', array('id' => 'id_secureicon'));
265 $mform->setType('secureicon', PARAM_URL);
477e8717 266 }
e27cb316 267
e3f69b58 268 // Add privacy preferences fieldset where users choose whether to send their data.
996b0fd9
CS
269 $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
270
aa74cccb 271 $mform->addElement('advcheckbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
996b0fd9 272 $mform->setDefault('instructorchoicesendname', '1');
b26dc53c 273 $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
e3f69b58 274 $mform->disabledIf('instructorchoicesendname', 'typeid', 'in', $toolproxy);
e27cb316 275
aa74cccb 276 $mform->addElement('advcheckbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
996b0fd9 277 $mform->setDefault('instructorchoicesendemailaddr', '1');
b26dc53c 278 $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
e3f69b58 279 $mform->disabledIf('instructorchoicesendemailaddr', 'typeid', 'in', $toolproxy);
e27cb316 280
aa74cccb 281 $mform->addElement('advcheckbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
996b0fd9 282 $mform->setDefault('instructorchoiceacceptgrades', '1');
b26dc53c 283 $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
e3f69b58 284 $mform->disabledIf('instructorchoiceacceptgrades', 'typeid', 'in', $toolproxy);
996b0fd9 285
8fa50fdd
MN
286 // Add standard course module grading elements.
287 $this->standard_grading_coursemodule_elements();
288
e3f69b58 289 // Add standard elements, common to all modules.
996b0fd9 290 $this->standard_coursemodule_elements();
996b0fd9 291 $mform->setAdvanced('cmidnumber');
e3f69b58 292
293 // Add standard buttons, common to all modules.
996b0fd9
CS
294 $this->add_action_buttons();
295
7302fbf6
TH
296 $editurl = new moodle_url('/mod/lti/instructor_edit_tool_type.php',
297 array('sesskey' => sesskey(), 'course' => $COURSE->id));
6831c7cd 298 $ajaxurl = new moodle_url('/mod/lti/ajax.php');
e27cb316 299
663640f5
DW
300 // All these icon uses are incorrect. LTI JS needs updating to use AMD modules and templates so it can use
301 // the mustache pix helper - until then LTI will have inconsistent icons.
996b0fd9 302 $jsinfo = (object)array(
663640f5
DW
303 'edit_icon_url' => (string)$OUTPUT->image_url('t/edit'),
304 'add_icon_url' => (string)$OUTPUT->image_url('t/add'),
305 'delete_icon_url' => (string)$OUTPUT->image_url('t/delete'),
306 'green_check_icon_url' => (string)$OUTPUT->image_url('i/valid'),
307 'warning_icon_url' => (string)$OUTPUT->image_url('warning', 'lti'),
6831c7cd
CS
308 'instructor_tool_type_edit_url' => $editurl->out(false),
309 'ajax_url' => $ajaxurl->out(true),
310 'courseId' => $COURSE->id
996b0fd9 311 );
e27cb316 312
996b0fd9 313 $module = array(
e3f69b58 314 'name' => 'mod_lti_edit',
315 'fullpath' => '/mod/lti/mod_form.js',
316 'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
317 'strings' => array(
6831c7cd
CS
318 array('addtype', 'lti'),
319 array('edittype', 'lti'),
320 array('deletetype', 'lti'),
321 array('delete_confirmation', 'lti'),
322 array('cannot_edit', 'lti'),
323 array('cannot_delete', 'lti'),
324 array('global_tool_types', 'lti'),
16e8f130
CS
325 array('course_tool_types', 'lti'),
326 array('using_tool_configuration', 'lti'),
af9d3a92 327 array('using_tool_cartridge', 'lti'),
16e8f130
CS
328 array('domain_mismatch', 'lti'),
329 array('custom_config', 'lti'),
4c598b13 330 array('tool_config_not_found', 'lti'),
af9d3a92
JO
331 array('tooltypeadded', 'lti'),
332 array('tooltypedeleted', 'lti'),
333 array('tooltypenotdeleted', 'lti'),
334 array('tooltypeupdated', 'lti'),
4c598b13 335 array('forced_help', 'lti')
6831c7cd 336 ),
996b0fd9 337 );
e27cb316 338
01e8bfd7
JO
339 if (!empty($typeid)) {
340 $mform->setAdvanced('typeid');
341 $mform->setAdvanced('toolurl');
342 }
343
996b0fd9
CS
344 $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
345 }
346
996b0fd9 347}