Merge branch 'MDL-50801_master' of git://github.com/dmonllao/moodle
[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() {
996b0fd9
CS
57 global $DB, $PAGE, $OUTPUT, $USER, $COURSE;
58
976b5bca
CS
59 if ($type = optional_param('type', false, PARAM_ALPHA)) {
60 component_callback("ltisource_$type", 'add_instance_hook');
61 }
8cf7670e 62
996b0fd9 63 $this->typeid = 0;
e27cb316 64
996b0fd9 65 $mform =& $this->_form;
e3f69b58 66 // Adding the "general" fieldset, where all the common settings are shown.
996b0fd9 67 $mform->addElement('header', 'general', get_string('general', 'form'));
e3f69b58 68 // Adding the standard "name" field.
69 $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size' => '64'));
996b0fd9
CS
70 $mform->setType('name', PARAM_TEXT);
71 $mform->addRule('name', null, 'required', null, 'client');
a74cd331 72 $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
e3f69b58 73 // Adding the optional "intro" and "introformat" pair of fields.
6398ff53 74 $this->standard_intro_elements(get_string('basicltiintro', 'lti'));
996b0fd9 75 $mform->setAdvanced('introeditor');
194f2c60 76
e3f69b58 77 // Display the label to the right of the checkbox so it looks better & matches rest of the form.
8b40604a
AS
78 if ($mform->elementExists('showdescription')) {
79 $coursedesc = $mform->getElement('showdescription');
80 if (!empty($coursedesc)) {
81 $coursedesc->setText(' ' . $coursedesc->getLabel());
82 $coursedesc->setLabel('&nbsp');
83 }
b07878ec 84 }
194f2c60 85
b07878ec 86 $mform->setAdvanced('showdescription');
996b0fd9 87
b07878ec
CS
88 $mform->addElement('checkbox', 'showtitlelaunch', '&nbsp;', ' ' . get_string('display_name', 'lti'));
89 $mform->setAdvanced('showtitlelaunch');
80fd0072 90 $mform->setDefault('showtitlelaunch', true);
b07878ec 91 $mform->addHelpButton('showtitlelaunch', 'display_name', 'lti');
e27cb316 92
b07878ec
CS
93 $mform->addElement('checkbox', 'showdescriptionlaunch', '&nbsp;', ' ' . get_string('display_description', 'lti'));
94 $mform->setAdvanced('showdescriptionlaunch');
95 $mform->addHelpButton('showdescriptionlaunch', 'display_description', 'lti');
e27cb316 96
e3f69b58 97 // Tool settings.
996b0fd9 98 $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), array());
b26dc53c 99 $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
e3f69b58 100 $toolproxy = array();
e27cb316 101
ea04a9f9 102 foreach (lti_get_types_for_add_instance() as $id => $type) {
e3f69b58 103 if (!empty($type->toolproxyid)) {
104 $toolproxy[] = $type->id;
105 $attributes = array( 'globalTool' => 1, 'toolproxy' => 1);
106 $enabledcapabilities = explode("\n", $type->enabledcapability);
107 if (!in_array('Result.autocreate', $enabledcapabilities)) {
108 $attributes['nogrades'] = 1;
109 }
110 if (!in_array('Person.name.full', $enabledcapabilities) && !in_array('Person.name.family', $enabledcapabilities) &&
111 !in_array('Person.name.given', $enabledcapabilities)) {
112 $attributes['noname'] = 1;
113 }
114 if (!in_array('Person.email.primary', $enabledcapabilities)) {
115 $attributes['noemail'] = 1;
116 }
117 } else if ($type->course == $COURSE->id) {
16e8f130 118 $attributes = array( 'editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain );
ea04a9f9 119 } else if ($id != 0) {
16e8f130 120 $attributes = array( 'globalTool' => 1, 'domain' => $type->tooldomain);
996b0fd9
CS
121 } else {
122 $attributes = array();
123 }
e27cb316 124
996b0fd9
CS
125 $tooltypes->addOption($type->name, $id, $attributes);
126 }
e27cb316 127
e3f69b58 128 $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size' => '64'));
996b0fd9 129 $mform->setType('toolurl', PARAM_TEXT);
b26dc53c 130 $mform->addHelpButton('toolurl', 'launch_url', 'lti');
e3f69b58 131 $mform->disabledIf('toolurl', 'typeid', 'neq', '0');
e27cb316 132
e3f69b58 133 $mform->addElement('text', 'securetoolurl', get_string('secure_launch_url', 'lti'), array('size' => '64'));
d8d04121
CS
134 $mform->setType('securetoolurl', PARAM_TEXT);
135 $mform->setAdvanced('securetoolurl');
136 $mform->addHelpButton('securetoolurl', 'secure_launch_url', 'lti');
e3f69b58 137 $mform->disabledIf('securetoolurl', 'typeid', 'neq', '0');
e27cb316 138
ea5d0515
AF
139 $mform->addElement('hidden', 'urlmatchedtypeid', '', array( 'id' => 'id_urlmatchedtypeid' ));
140 $mform->setType('urlmatchedtypeid', PARAM_INT);
141
e3f69b58 142 $launchoptions = array();
996b0fd9
CS
143 $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
144 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
145 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
8fa50fdd 146 $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
996b0fd9
CS
147 $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
148
149 $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
150 $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
b26dc53c 151 $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
e27cb316 152
996b0fd9
CS
153 $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
154 $mform->setType('resourcekey', PARAM_TEXT);
155 $mform->setAdvanced('resourcekey');
b26dc53c 156 $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
e3f69b58 157 $mform->disabledIf('resourcekey', 'typeid', 'neq', '0');
e27cb316 158
996b0fd9
CS
159 $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
160 $mform->setType('password', PARAM_TEXT);
161 $mform->setAdvanced('password');
b26dc53c 162 $mform->addHelpButton('password', 'password', 'lti');
e3f69b58 163 $mform->disabledIf('password', 'typeid', 'neq', '0');
e27cb316 164
e3f69b58 165 $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
996b0fd9
CS
166 $mform->setType('instructorcustomparameters', PARAM_TEXT);
167 $mform->setAdvanced('instructorcustomparameters');
b26dc53c 168 $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
e27cb316 169
e3f69b58 170 $mform->addElement('text', 'icon', get_string('icon_url', 'lti'), array('size' => '64'));
3f358828 171 $mform->setType('icon', PARAM_URL);
6d462df8 172 $mform->setAdvanced('icon');
d8d04121 173 $mform->addHelpButton('icon', 'icon_url', 'lti');
e3f69b58 174 $mform->disabledIf('icon', 'typeid', 'neq', '0');
e27cb316 175
e3f69b58 176 $mform->addElement('text', 'secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
3f358828 177 $mform->setType('secureicon', PARAM_URL);
d8d04121
CS
178 $mform->setAdvanced('secureicon');
179 $mform->addHelpButton('secureicon', 'secure_icon_url', 'lti');
e3f69b58 180 $mform->disabledIf('secureicon', 'typeid', 'neq', '0');
e27cb316 181
e3f69b58 182 // Add privacy preferences fieldset where users choose whether to send their data.
996b0fd9
CS
183 $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
184
aa74cccb 185 $mform->addElement('advcheckbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
996b0fd9 186 $mform->setDefault('instructorchoicesendname', '1');
b26dc53c 187 $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
e3f69b58 188 $mform->disabledIf('instructorchoicesendname', 'typeid', 'in', $toolproxy);
e27cb316 189
aa74cccb 190 $mform->addElement('advcheckbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
996b0fd9 191 $mform->setDefault('instructorchoicesendemailaddr', '1');
b26dc53c 192 $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
e3f69b58 193 $mform->disabledIf('instructorchoicesendemailaddr', 'typeid', 'in', $toolproxy);
e27cb316 194
aa74cccb 195 $mform->addElement('advcheckbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
996b0fd9 196 $mform->setDefault('instructorchoiceacceptgrades', '1');
b26dc53c 197 $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
e3f69b58 198 $mform->disabledIf('instructorchoiceacceptgrades', 'typeid', 'in', $toolproxy);
996b0fd9 199
8fa50fdd
MN
200 // Add standard course module grading elements.
201 $this->standard_grading_coursemodule_elements();
202
e3f69b58 203 // Add standard elements, common to all modules.
996b0fd9 204 $this->standard_coursemodule_elements();
996b0fd9 205 $mform->setAdvanced('cmidnumber');
e3f69b58 206
207 // Add standard buttons, common to all modules.
996b0fd9
CS
208 $this->add_action_buttons();
209
7302fbf6
TH
210 $editurl = new moodle_url('/mod/lti/instructor_edit_tool_type.php',
211 array('sesskey' => sesskey(), 'course' => $COURSE->id));
6831c7cd 212 $ajaxurl = new moodle_url('/mod/lti/ajax.php');
e27cb316 213
996b0fd9
CS
214 $jsinfo = (object)array(
215 'edit_icon_url' => (string)$OUTPUT->pix_url('t/edit'),
216 'add_icon_url' => (string)$OUTPUT->pix_url('t/add'),
217 'delete_icon_url' => (string)$OUTPUT->pix_url('t/delete'),
c3847443 218 'green_check_icon_url' => (string)$OUTPUT->pix_url('i/valid'),
16e8f130 219 'warning_icon_url' => (string)$OUTPUT->pix_url('warning', 'lti'),
6831c7cd
CS
220 'instructor_tool_type_edit_url' => $editurl->out(false),
221 'ajax_url' => $ajaxurl->out(true),
222 'courseId' => $COURSE->id
996b0fd9 223 );
e27cb316 224
996b0fd9 225 $module = array(
e3f69b58 226 'name' => 'mod_lti_edit',
227 'fullpath' => '/mod/lti/mod_form.js',
228 'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
229 'strings' => array(
6831c7cd
CS
230 array('addtype', 'lti'),
231 array('edittype', 'lti'),
232 array('deletetype', 'lti'),
233 array('delete_confirmation', 'lti'),
234 array('cannot_edit', 'lti'),
235 array('cannot_delete', 'lti'),
236 array('global_tool_types', 'lti'),
16e8f130
CS
237 array('course_tool_types', 'lti'),
238 array('using_tool_configuration', 'lti'),
239 array('domain_mismatch', 'lti'),
240 array('custom_config', 'lti'),
4c598b13
CS
241 array('tool_config_not_found', 'lti'),
242 array('forced_help', 'lti')
6831c7cd 243 ),
996b0fd9 244 );
e27cb316 245
996b0fd9
CS
246 $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
247 }
248
996b0fd9
CS
249}
250