85507c0bcab771f191d65c2306caa5c322d6c4fd
[moodle.git] / mod / lti / edit_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 de main basiclti 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     Charles Severance
46  * @author     Chris Scribner
47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  */
50 defined('MOODLE_INTERNAL') || die;
52 global $CFG;
53 require_once($CFG->libdir.'/formslib.php');
54 require_once($CFG->dirroot.'/mod/lti/locallib.php');
56 /**
57  * LTI Edit Form
58  *
59  * @package    mod_lti
60  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
61  *  marc.alier@upc.edu
62  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
63  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
64  */
65 class mod_lti_edit_types_form extends moodleform {
67     /**
68      * Define this form.
69      */
70     public function definition() {
71         global $CFG, $PAGE;
73         $mform    =& $this->_form;
75         $istool = $this->_customdata && isset($this->_customdata->istool) && $this->_customdata->istool;
76         $typeid = $this->_customdata->id ?? '';
77         $clientid = $this->_customdata->clientid ?? '';
79         // Add basiclti elements.
80         $mform->addElement('header', 'setup', get_string('tool_settings', 'lti'));
82         $mform->addElement('text', 'lti_typename', get_string('typename', 'lti'));
83         $mform->setType('lti_typename', PARAM_TEXT);
84         $mform->addHelpButton('lti_typename', 'typename', 'lti');
85         $mform->addRule('lti_typename', null, 'required', null, 'client');
87         $mform->addElement('text', 'lti_toolurl', get_string('toolurl', 'lti'), array('size' => '64'));
88         $mform->setType('lti_toolurl', PARAM_URL);
89         $mform->addHelpButton('lti_toolurl', 'toolurl', 'lti');
91         $mform->addElement('textarea', 'lti_description', get_string('tooldescription', 'lti'), array('rows' => 4, 'cols' => 60));
92         $mform->setType('lti_description', PARAM_TEXT);
93         $mform->addHelpButton('lti_description', 'tooldescription', 'lti');
94         if (!$istool) {
95             $mform->addRule('lti_toolurl', null, 'required', null, 'client');
96         } else {
97             $mform->disabledIf('lti_toolurl', null);
98         }
100         if (!$istool) {
101             $options = array(
102                 LTI_VERSION_1 => get_string('oauthsecurity', 'lti'),
103                 LTI_VERSION_1P3 => get_string('jwtsecurity', 'lti'),
104             );
105             $mform->addElement('select', 'lti_ltiversion', get_string('ltiversion', 'lti'), $options);
106             $mform->setType('lti_ltiversion', PARAM_TEXT);
107             $mform->addHelpButton('lti_ltiversion', 'ltiversion', 'lti');
108             $mform->setDefault('lti_ltiversion', LTI_VERSION_1);
110             $mform->addElement('text', 'lti_resourcekey', get_string('resourcekey_admin', 'lti'));
111             $mform->setType('lti_resourcekey', PARAM_TEXT);
112             $mform->addHelpButton('lti_resourcekey', 'resourcekey_admin', 'lti');
113             $mform->hideIf('lti_resourcekey', 'lti_ltiversion', 'eq', LTI_VERSION_1P3);
114             $mform->setForceLtr('lti_resourcekey');
116             $mform->addElement('passwordunmask', 'lti_password', get_string('password_admin', 'lti'));
117             $mform->setType('lti_password', PARAM_TEXT);
118             $mform->addHelpButton('lti_password', 'password_admin', 'lti');
119             $mform->hideIf('lti_password', 'lti_ltiversion', 'eq', LTI_VERSION_1P3);
121             if (!empty($typeid)) {
122                 $mform->addElement('text', 'lti_clientid_disabled', get_string('clientidadmin', 'lti'));
123                 $mform->setType('lti_clientid_disabled', PARAM_TEXT);
124                 $mform->addHelpButton('lti_clientid_disabled', 'clientidadmin', 'lti');
125                 $mform->hideIf('lti_clientid_disabled', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
126                 $mform->disabledIf('lti_clientid_disabled', null);
127                 $mform->setForceLtr('lti_clientid_disabled');
128                 $mform->addElement('hidden', 'lti_clientid');
129                 $mform->setType('lti_clientid', PARAM_TEXT);
130             }
132             $mform->addElement('textarea', 'lti_publickey', get_string('publickey', 'lti'), array('rows' => 8, 'cols' => 60));
133             $mform->setType('lti_publickey', PARAM_TEXT);
134             $mform->addHelpButton('lti_publickey', 'publickey', 'lti');
135             $mform->hideIf('lti_publickey', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
136             $mform->setForceLtr('lti_publickey');
138             $mform->addElement('text', 'lti_initiatelogin', get_string('initiatelogin', 'lti'), array('size' => '64'));
139             $mform->setType('lti_initiatelogin', PARAM_URL);
140             $mform->addHelpButton('lti_initiatelogin', 'initiatelogin', 'lti');
141             $mform->hideIf('lti_initiatelogin', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
143             $mform->addElement('textarea', 'lti_redirectionuris', get_string('redirectionuris', 'lti'),
144                 array('rows' => 3, 'cols' => 60));
145             $mform->setType('lti_redirectionuris', PARAM_TEXT);
146             $mform->addHelpButton('lti_redirectionuris', 'redirectionuris', 'lti');
147             $mform->hideIf('lti_redirectionuris', 'lti_ltiversion', 'neq', LTI_VERSION_1P3);
148             $mform->setForceLtr('lti_redirectionuris');
149         }
151         if ($istool) {
152             $mform->addElement('textarea', 'lti_parameters', get_string('parameter', 'lti'), array('rows' => 4, 'cols' => 60));
153             $mform->setType('lti_parameters', PARAM_TEXT);
154             $mform->addHelpButton('lti_parameters', 'parameter', 'lti');
155             $mform->disabledIf('lti_parameters', null);
156             $mform->setForceLtr('lti_parameters');
157         }
159         $mform->addElement('textarea', 'lti_customparameters', get_string('custom', 'lti'), array('rows' => 4, 'cols' => 60));
160         $mform->setType('lti_customparameters', PARAM_TEXT);
161         $mform->addHelpButton('lti_customparameters', 'custom', 'lti');
162         $mform->setForceLtr('lti_customparameters');
164         if (!empty($this->_customdata->isadmin)) {
165             $options = array(
166                 LTI_COURSEVISIBLE_NO => get_string('show_in_course_no', 'lti'),
167                 LTI_COURSEVISIBLE_PRECONFIGURED => get_string('show_in_course_preconfigured', 'lti'),
168                 LTI_COURSEVISIBLE_ACTIVITYCHOOSER => get_string('show_in_course_activity_chooser', 'lti'),
169             );
170             if ($istool) {
171                 // LTI2 tools can not be matched by URL, they have to be either in preconfigured tools or in activity chooser.
172                 unset($options[LTI_COURSEVISIBLE_NO]);
173                 $stringname = 'show_in_course_lti2';
174             } else {
175                 $stringname = 'show_in_course_lti1';
176             }
177             $mform->addElement('select', 'lti_coursevisible', get_string($stringname, 'lti'), $options);
178             $mform->addHelpButton('lti_coursevisible', $stringname, 'lti');
179             $mform->setDefault('lti_coursevisible', '1');
180         } else {
181             $mform->addElement('hidden', 'lti_coursevisible', LTI_COURSEVISIBLE_PRECONFIGURED);
182         }
183         $mform->setType('lti_coursevisible', PARAM_INT);
185         $mform->addElement('hidden', 'typeid');
186         $mform->setType('typeid', PARAM_INT);
188         $launchoptions = array();
189         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
190         $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
191         $launchoptions[LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW] = get_string('existing_window', 'lti');
192         $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
194         $mform->addElement('select', 'lti_launchcontainer', get_string('default_launch_container', 'lti'), $launchoptions);
195         $mform->setDefault('lti_launchcontainer', LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS);
196         $mform->addHelpButton('lti_launchcontainer', 'default_launch_container', 'lti');
197         $mform->setType('lti_launchcontainer', PARAM_INT);
199         $mform->addElement('advcheckbox', 'lti_contentitem', get_string('contentitem', 'lti'));
200         $mform->addHelpButton('lti_contentitem', 'contentitem', 'lti');
201         $mform->setAdvanced('lti_contentitem');
202         if ($istool) {
203             $mform->disabledIf('lti_contentitem', null);
204         }
206         $mform->addElement('text', 'lti_toolurl_ContentItemSelectionRequest',
207             get_string('toolurl_contentitemselectionrequest', 'lti'), array('size' => '64'));
208         $mform->setType('lti_toolurl_ContentItemSelectionRequest', PARAM_URL);
209         $mform->setAdvanced('lti_toolurl_ContentItemSelectionRequest');
210         $mform->addHelpButton('lti_toolurl_ContentItemSelectionRequest', 'toolurl_contentitemselectionrequest', 'lti');
211         $mform->disabledIf('lti_toolurl_ContentItemSelectionRequest', 'lti_contentitem', 'notchecked');
212         if ($istool) {
213             $mform->disabledIf('lti_toolurl__ContentItemSelectionRequest', null);
214         }
216         $mform->addElement('hidden', 'oldicon');
217         $mform->setType('oldicon', PARAM_URL);
219         $mform->addElement('text', 'lti_icon', get_string('icon_url', 'lti'), array('size' => '64'));
220         $mform->setType('lti_icon', PARAM_URL);
221         $mform->setAdvanced('lti_icon');
222         $mform->addHelpButton('lti_icon', 'icon_url', 'lti');
224         $mform->addElement('text', 'lti_secureicon', get_string('secure_icon_url', 'lti'), array('size' => '64'));
225         $mform->setType('lti_secureicon', PARAM_URL);
226         $mform->setAdvanced('lti_secureicon');
227         $mform->addHelpButton('lti_secureicon', 'secure_icon_url', 'lti');
229         if (!$istool) {
230             // Display the lti advantage services.
231             $this->get_lti_advantage_services($mform);
232         }
234         if (!$istool) {
235             // Add privacy preferences fieldset where users choose whether to send their data.
236             $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
238             $options = array();
239             $options[0] = get_string('never', 'lti');
240             $options[1] = get_string('always', 'lti');
241             $options[2] = get_string('delegate', 'lti');
243             $mform->addElement('select', 'lti_sendname', get_string('share_name_admin', 'lti'), $options);
244             $mform->setType('lti_sendname', PARAM_INT);
245             $mform->setDefault('lti_sendname', '2');
246             $mform->addHelpButton('lti_sendname', 'share_name_admin', 'lti');
248             $mform->addElement('select', 'lti_sendemailaddr', get_string('share_email_admin', 'lti'), $options);
249             $mform->setType('lti_sendemailaddr', PARAM_INT);
250             $mform->setDefault('lti_sendemailaddr', '2');
251             $mform->addHelpButton('lti_sendemailaddr', 'share_email_admin', 'lti');
253             // LTI Extensions.
255             // Add grading preferences fieldset where the tool is allowed to return grades.
256             $mform->addElement('select', 'lti_acceptgrades', get_string('accept_grades_admin', 'lti'), $options);
257             $mform->setType('lti_acceptgrades', PARAM_INT);
258             $mform->setDefault('lti_acceptgrades', '2');
259             $mform->addHelpButton('lti_acceptgrades', 'accept_grades_admin', 'lti');
261             $mform->addElement('checkbox', 'lti_forcessl', '&nbsp;', ' ' . get_string('force_ssl', 'lti'), $options);
262             $mform->setType('lti_forcessl', PARAM_BOOL);
263             if (!empty($CFG->mod_lti_forcessl)) {
264                 $mform->setDefault('lti_forcessl', '1');
265                 $mform->freeze('lti_forcessl');
266             } else {
267                 $mform->setDefault('lti_forcessl', '0');
268             }
269             $mform->addHelpButton('lti_forcessl', 'force_ssl', 'lti');
271             if (!empty($this->_customdata->isadmin)) {
272                 // Add setup parameters fieldset.
273                 $mform->addElement('header', 'setupoptions', get_string('miscellaneous', 'lti'));
275                 $options = array(
276                     LTI_DEFAULT_ORGID_SITEID => get_string('siteid', 'lti'),
277                     LTI_DEFAULT_ORGID_SITEHOST => get_string('sitehost', 'lti'),
278                 );
280                 $mform->addElement('select', 'lti_organizationid_default', get_string('organizationid_default', 'lti'), $options);
281                 $mform->setType('lti_organizationid_default', PARAM_TEXT);
282                 $mform->setDefault('lti_organizationid_default', LTI_DEFAULT_ORGID_SITEID);
283                 $mform->addHelpButton('lti_organizationid_default', 'organizationid_default', 'lti');
285                 $mform->addElement('text', 'lti_organizationid', get_string('organizationidguid', 'lti'));
286                 $mform->setType('lti_organizationid', PARAM_TEXT);
287                 $mform->addHelpButton('lti_organizationid', 'organizationidguid', 'lti');
289                 $mform->addElement('text', 'lti_organizationurl', get_string('organizationurl', 'lti'));
290                 $mform->setType('lti_organizationurl', PARAM_URL);
291                 $mform->addHelpButton('lti_organizationurl', 'organizationurl', 'lti');
292             }
293         }
295         /* Suppress this for now - Chuck
296          * mform->addElement('text', 'lti_organizationdescr', get_string('organizationdescr', 'lti'))
297          * mform->setType('lti_organizationdescr', PARAM_TEXT)
298          * mform->addHelpButton('lti_organizationdescr', 'organizationdescr', 'lti')
299          */
301         /*
302         // Add a hidden element to signal a tool fixing operation after a problematic backup - restore process
303         //$mform->addElement('hidden', 'lti_fix');
304         */
306         $tab = optional_param('tab', '', PARAM_ALPHAEXT);
307         $mform->addElement('hidden', 'tab', $tab);
308         $mform->setType('tab', PARAM_ALPHAEXT);
310         $courseid = optional_param('course', 1, PARAM_INT);
311         $mform->addElement('hidden', 'course', $courseid);
312         $mform->setType('course', PARAM_INT);
314         // Add standard buttons, common to all modules.
315         $this->add_action_buttons();
317     }
319     /**
320      * Retrieves the data of the submitted form.
321      *
322      * @return stdClass
323      */
324     public function get_data() {
325         $data = parent::get_data();
326         if ($data && !empty($this->_customdata->istool)) {
327             // Content item checkbox is disabled in tool settings, so this cannot be edited. Just unset it.
328             unset($data->lti_contentitem);
329         }
330         return $data;
331     }
333     /**
334      * Generates the lti advantage extra configuration adding it to the mform
335      *
336      * @param MoodleQuickForm $mform
337      */
338     public function get_lti_advantage_services(&$mform) {
339         // For each service add the label and get the array of configuration.
340         $services = lti_get_services();
341         $mform->addElement('header', 'services', get_string('services', 'lti'));
342         foreach ($services as $service) {
343             /** @var \mod_lti\local\ltiservice\service_base $service */
344             $service->get_configuration_options($mform);
345         }
346     }
348     /**
349      * Validate the form data before we allow them to save the tool type.
350      *
351      * @param array $data
352      * @param array $files
353      * @return array Error messages
354      */
355     public function validation($data, $files) {
356         global $CFG;
358         $errors = parent::validation($data, $files);
360         // LTI2 tools do not contain a ltiversion field.
361         if (isset($data['lti_ltiversion']) && $data['lti_ltiversion'] == LTI_VERSION_1P3) {
362             require_once($CFG->dirroot . '/mod/lti/upgradelib.php');
364             $warning = mod_lti_verify_private_key();
365             if (!empty($warning)) {
366                 $errors['lti_ltiversion'] = $warning;
367                 return $errors;
368             }
369         }
370         return $errors;
371     }