Merge branch 'MDL-62815_mod_lti' of git://github.com/davosmith/moodle
[moodle.git] / 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.
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  */
49 defined('MOODLE_INTERNAL') || die;
51 require_once($CFG->dirroot.'/course/moodleform_mod.php');
52 require_once($CFG->dirroot.'/mod/lti/locallib.php');
54 class mod_lti_mod_form extends moodleform_mod {
56     public function definition() {
57         global $PAGE, $OUTPUT, $COURSE;
59         if ($type = optional_param('type', false, PARAM_ALPHA)) {
60             component_callback("ltisource_$type", 'add_instance_hook');
61         }
63         // Type ID parameter being passed when adding an preconfigured tool from activity chooser.
64         $typeid = optional_param('typeid', false, PARAM_INT);
66         // Show configuration details only if not preset (when new) or user has the capabilities to do so (when editing).
67         if ($this->_instance) {
68             $showtypes = has_capability('mod/lti:addpreconfiguredinstance', $this->context);
69             $showoptions = has_capability('mod/lti:addmanualinstance', $this->context);
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;
77             $showoptions = !$typeid && has_capability('mod/lti:addmanualinstance', $this->context);
78         }
80         $this->typeid = 0;
82         $mform =& $this->_form;
83         // Adding the "general" fieldset, where all the common settings are shown.
84         $mform->addElement('header', 'general', get_string('general', 'form'));
85         // Adding the standard "name" field.
86         $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size' => '64'));
87         $mform->setType('name', PARAM_TEXT);
88         $mform->addRule('name', null, 'required', null, 'client');
89         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
90         // Adding the optional "intro" and "introformat" pair of fields.
91         $this->standard_intro_elements(get_string('basicltiintro', 'lti'));
92         $mform->setAdvanced('introeditor');
94         // Display the label to the right of the checkbox so it looks better & matches rest of the form.
95         if ($mform->elementExists('showdescription')) {
96             $coursedesc = $mform->getElement('showdescription');
97             if (!empty($coursedesc)) {
98                 $coursedesc->setText(' ' . $coursedesc->getLabel());
99                 $coursedesc->setLabel('&nbsp');
100             }
101         }
103         $mform->setAdvanced('showdescription');
105         $mform->addElement('checkbox', 'showtitlelaunch', '&nbsp;', ' ' . get_string('display_name', 'lti'));
106         $mform->setAdvanced('showtitlelaunch');
107         $mform->setDefault('showtitlelaunch', true);
108         $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
110         $mform->addElement('checkbox', 'showdescriptionlaunch', '&nbsp;', ' ' . get_string('display_description', 'lti'));
111         $mform->setAdvanced('showdescriptionlaunch');
112         $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
114         // Tool settings.
115         $toolproxy = array();
116         // Array of tool type IDs that don't support ContentItemSelectionRequest.
117         $noncontentitemtypes = [];
119         if ($showtypes) {
120             $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'));
121             if ($typeid) {
122                 $mform->getElement('typeid')->setValue($typeid);
123             }
124             $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
126             foreach (lti_get_types_for_add_instance() as $id => $type) {
127                 if (!empty($type->toolproxyid)) {
128                     $toolproxy[] = $type->id;
129                     $attributes = array('globalTool' => 1, 'toolproxy' => 1);
130                     $enabledcapabilities = explode("\n", $type->enabledcapability);
131                     if (!in_array('Result.autocreate', $enabledcapabilities) ||
132                         in_array('BasicOutcome.url', $enabledcapabilities)) {
133                         $attributes['nogrades'] = 1;
134                     }
135                     if (!in_array('Person.name.full', $enabledcapabilities) &&
136                         !in_array('Person.name.family', $enabledcapabilities) &&
137                         !in_array('Person.name.given', $enabledcapabilities)) {
138                         $attributes['noname'] = 1;
139                     }
140                     if (!in_array('Person.email.primary', $enabledcapabilities)) {
141                         $attributes['noemail'] = 1;
142                     }
143                 } else if ($type->course == $COURSE->id) {
144                     $attributes = array('editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain);
145                 } else if ($id != 0) {
146                     $attributes = array('globalTool' => 1, 'domain' => $type->tooldomain);
147                 } else {
148                     $attributes = array();
149                 }
151                 if ($id) {
152                     $config = lti_get_type_config($id);
153                     if (!empty($config['contentitem'])) {
154                         $attributes['data-contentitem'] = 1;
155                         $attributes['data-id'] = $id;
156                     } else {
157                         $noncontentitemtypes[] = $id;
158                     }
159                 }
160                 $tooltypes->addOption($type->name, $id, $attributes);
161             }
162         } else {
163             $mform->addElement('hidden', 'typeid', $typeid);
164             $mform->setType('typeid', PARAM_INT);
165             if ($typeid) {
166                 $config = lti_get_type_config($typeid);
167                 if (!empty($config['contentitem'])) {
168                     $mform->addElement('hidden', 'contentitem', 1);
169                     $mform->setType('contentitem', PARAM_INT);
170                 }
171             }
172         }
174         // Add button that launches the content-item selection dialogue.
175         // Set contentitem URL.
176         $contentitemurl = new moodle_url('/mod/lti/contentitem.php');
177         $contentbuttonattributes = [
178             'data-contentitemurl' => $contentitemurl->out(false)
179         ];
180         if (!$showtypes) {
181             if (!$typeid || empty(lti_get_type_config($typeid)['contentitem'])) {
182                 $contentbuttonattributes['disabled'] = 'disabled';
183             }
184         }
185         $contentbuttonlabel = get_string('selectcontent', 'lti');
186         $contentbutton = $mform->addElement('button', 'selectcontent', $contentbuttonlabel, $contentbuttonattributes);
187         // Disable select content button if the selected tool doesn't support content item or it's set to Automatic.
188         if ($showtypes) {
189             $allnoncontentitemtypes = $noncontentitemtypes;
190             $allnoncontentitemtypes[] = '0'; // Add option value for "Automatic, based on tool URL".
191             $mform->disabledIf('selectcontent', 'typeid', 'in', $allnoncontentitemtypes);
192         }
194         if ($showoptions) {
195             $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size' => '64'));
196             $mform->setType('toolurl', PARAM_URL);
197             $mform->addHelpButton('toolurl', 'launch_url', 'lti');
198             $mform->hideIf('toolurl', 'typeid', 'in', $noncontentitemtypes);
200             $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size' => '64'));
201             $mform->setType('securetoolurl', PARAM_URL);
202             $mform->setAdvanced('securetoolurl');
203             $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
204             $mform->hideIf('securetoolurl', 'typeid', 'in', $noncontentitemtypes);
205         }
207         $mform->addElement('hidden', 'urlmatchedtypeid', '', array( 'id' => 'id_urlmatchedtypeid' ));
208         $mform->setType('urlmatchedtypeid', PARAM_INT);
210         $launchoptions = array();
211         $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
212         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
213         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
214         $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
215         $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
217         $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
218         $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
219         $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
220         $mform->setAdvanced('launchcontainer');
222         if ($showoptions) {
223             $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
224             $mform->setType('resourcekey', PARAM_TEXT);
225             $mform->setAdvanced('resourcekey');
226             $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
227             $mform->setForceLtr('resourcekey');
228             $mform->hideIf('resourcekey', 'typeid', 'in', $noncontentitemtypes);
230             $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
231             $mform->setType('password', PARAM_TEXT);
232             $mform->setAdvanced('password');
233             $mform->addHelpButton('password', 'password', 'lti');
234             $mform->hideIf('password', 'typeid', 'in', $noncontentitemtypes);
236             $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
237             $mform->setType('instructorcustomparameters', PARAM_TEXT);
238             $mform->setAdvanced('instructorcustomparameters');
239             $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
240             $mform->setForceLtr('instructorcustomparameters');
242             $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size' => '64'));
243             $mform->setType('icon', PARAM_URL);
244             $mform->setAdvanced('icon');
245             $mform->addHelpButton('icon', 'icon_url', 'lti');
246             $mform->hideIf('icon', 'typeid', 'in', $noncontentitemtypes);
248             $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
249             $mform->setType('secureicon', PARAM_URL);
250             $mform->setAdvanced('secureicon');
251             $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
252             $mform->hideIf('secureicon', 'typeid', 'in', $noncontentitemtypes);
253         }
255         // Add privacy preferences fieldset where users choose whether to send their data.
256         $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
258         $mform->addElement('advcheckbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
259         $mform->setDefault('instructorchoicesendname', '1');
260         $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
261         $mform->disabledIf('instructorchoicesendname', 'typeid', 'in', $toolproxy);
263         $mform->addElement('advcheckbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
264         $mform->setDefault('instructorchoicesendemailaddr', '1');
265         $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
266         $mform->disabledIf('instructorchoicesendemailaddr', 'typeid', 'in', $toolproxy);
268         $mform->addElement('advcheckbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
269         $mform->setDefault('instructorchoiceacceptgrades', '1');
270         $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
271         $mform->disabledIf('instructorchoiceacceptgrades', 'typeid', 'in', $toolproxy);
273         // Add standard course module grading elements.
274         $this->standard_grading_coursemodule_elements();
276         // Add standard elements, common to all modules.
277         $this->standard_coursemodule_elements();
278         $mform->setAdvanced('cmidnumber');
280         // Add standard buttons, common to all modules.
281         $this->add_action_buttons();
283         $editurl = new moodle_url('/mod/lti/instructor_edit_tool_type.php',
284                 array('sesskey' => sesskey(), 'course' => $COURSE->id));
285         $ajaxurl = new moodle_url('/mod/lti/ajax.php');
287         // All these icon uses are incorrect. LTI JS needs updating to use AMD modules and templates so it can use
288         // the mustache pix helper - until then LTI will have inconsistent icons.
289         $jsinfo = (object)array(
290                         'edit_icon_url' => (string)$OUTPUT->image_url('t/edit'),
291                         'add_icon_url' => (string)$OUTPUT->image_url('t/add'),
292                         'delete_icon_url' => (string)$OUTPUT->image_url('t/delete'),
293                         'green_check_icon_url' => (string)$OUTPUT->image_url('i/valid'),
294                         'warning_icon_url' => (string)$OUTPUT->image_url('warning', 'lti'),
295                         'instructor_tool_type_edit_url' => $editurl->out(false),
296                         'ajax_url' => $ajaxurl->out(true),
297                         'courseId' => $COURSE->id
298                   );
300         $module = array(
301             'name' => 'mod_lti_edit',
302             'fullpath' => '/mod/lti/mod_form.js',
303             'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
304             'strings' => array(
305                 array('addtype', 'lti'),
306                 array('edittype', 'lti'),
307                 array('deletetype', 'lti'),
308                 array('delete_confirmation', 'lti'),
309                 array('cannot_edit', 'lti'),
310                 array('cannot_delete', 'lti'),
311                 array('global_tool_types', 'lti'),
312                 array('course_tool_types', 'lti'),
313                 array('using_tool_configuration', 'lti'),
314                 array('using_tool_cartridge', 'lti'),
315                 array('domain_mismatch', 'lti'),
316                 array('custom_config', 'lti'),
317                 array('tool_config_not_found', 'lti'),
318                 array('tooltypeadded', 'lti'),
319                 array('tooltypedeleted', 'lti'),
320                 array('tooltypenotdeleted', 'lti'),
321                 array('tooltypeupdated', 'lti'),
322                 array('forced_help', 'lti')
323             ),
324         );
326         if (!empty($typeid)) {
327             $mform->setAdvanced('typeid');
328             $mform->setAdvanced('toolurl');
329         }
331         $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
332     }