Only consider configured tools when receiving LTI web service calls
[moodle.git] / mod / lti / mod_form.php
CommitLineData
996b0fd9
CS
1<?php
2// This file is part of BasicLTI4Moodle
3//
4// BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
5// consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
6// based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
7// specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
8// are already supporting or going to support BasicLTI. This project Implements the consumer
9// for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
10// BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
11// at the GESSI research group at UPC.
12// SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
13// by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
14// Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
15//
16// BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
17// of the Universitat Politecnica de Catalunya http://www.upc.edu
18// Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu
19//
20// Moodle is free software: you can redistribute it and/or modify
21// it under the terms of the GNU General Public License as published by
22// the Free Software Foundation, either version 3 of the License, or
23// (at your option) any later version.
24//
25// Moodle is distributed in the hope that it will be useful,
26// but WITHOUT ANY WARRANTY; without even the implied warranty of
27// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28// GNU General Public License for more details.
29//
30// You should have received a copy of the GNU General Public License
31// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
32
33/**
34 * This file defines the main basiclti configuration form
35 *
36 * @package lti
37 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
38 * marc.alier@upc.edu
39 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
40 *
41 * @author Marc Alier
42 * @author Jordi Piguillem
43 * @author Nikolas Galanis
44 *
45 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46 */
47
48defined('MOODLE_INTERNAL') || die;
49
50require_once($CFG->dirroot.'/course/moodleform_mod.php');
51require_once($CFG->dirroot.'/mod/lti/locallib.php');
52
53class mod_lti_mod_form extends moodleform_mod {
54
55 function definition() {
56 global $DB, $PAGE, $OUTPUT, $USER, $COURSE;
57
58 $this->typeid = 0;
59
60 $mform =& $this->_form;
61//-------------------------------------------------------------------------------
62 /// Adding the "general" fieldset, where all the common settings are shown
63 $mform->addElement('header', 'general', get_string('general', 'form'));
64 /// Adding the standard "name" field
65 $mform->addElement('text', 'name', get_string('basicltiname', 'lti'), array('size'=>'64'));
66 $mform->setType('name', PARAM_TEXT);
67 $mform->addRule('name', null, 'required', null, 'client');
68 /// Adding the optional "intro" and "introformat" pair of fields
69 $this->add_intro_editor(false, get_string('basicltiintro', 'lti'));
70 $mform->setAdvanced('introeditor');
71
72 $mform->addElement('checkbox', 'showtitle', '&nbsp;', ' ' . get_string('display_name', 'lti'));
73 $mform->setAdvanced('showtitle');
b26dc53c 74 $mform->addHelpButton('showtitle', 'display_name', 'lti');
996b0fd9
CS
75
76 $mform->addElement('checkbox', 'showdescription', '&nbsp;', ' ' . get_string('display_description', 'lti'));
77 $mform->setAdvanced('showdescription');
b26dc53c 78 $mform->addHelpButton('showdescription', 'display_description', 'lti');
996b0fd9
CS
79
80 //Tool settings
81 $tooltypes = $mform->addElement('select', 'typeid', get_string('external_tool_type', 'lti'), array());
b26dc53c 82 $mform->addHelpButton('typeid', 'external_tool_type', 'lti');
996b0fd9
CS
83
84 foreach(lti_get_types_for_add_instance() as $id => $type){
85 if($type->course == $COURSE->id) {
16e8f130 86 $attributes = array( 'editable' => 1, 'courseTool' => 1, 'domain' => $type->tooldomain );
6831c7cd 87 } else if($id != 0) {
16e8f130 88 $attributes = array( 'globalTool' => 1, 'domain' => $type->tooldomain);
996b0fd9
CS
89 } else {
90 $attributes = array();
91 }
92
93 $tooltypes->addOption($type->name, $id, $attributes);
94 }
95
96 $mform->addElement('text', 'toolurl', get_string('launch_url', 'lti'), array('size'=>'64'));
97 $mform->setType('toolurl', PARAM_TEXT);
b26dc53c 98 $mform->addHelpButton('toolurl', 'launch_url', 'lti');
996b0fd9
CS
99
100 $launchoptions=array();
101 $launchoptions[LTI_LAUNCH_CONTAINER_DEFAULT] = get_string('default', 'lti');
102 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED] = get_string('embed', 'lti');
103 $launchoptions[LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS] = get_string('embed_no_blocks', 'lti');
104 $launchoptions[LTI_LAUNCH_CONTAINER_WINDOW] = get_string('new_window', 'lti');
105
106 $mform->addElement('select', 'launchcontainer', get_string('launchinpopup', 'lti'), $launchoptions);
107 $mform->setDefault('launchcontainer', LTI_LAUNCH_CONTAINER_DEFAULT);
b26dc53c 108 $mform->addHelpButton('launchcontainer', 'launchinpopup', 'lti');
996b0fd9
CS
109
110 $mform->addElement('text', 'resourcekey', get_string('resourcekey', 'lti'));
111 $mform->setType('resourcekey', PARAM_TEXT);
112 $mform->setAdvanced('resourcekey');
b26dc53c
CS
113 $mform->addHelpButton('resourcekey', 'resourcekey', 'lti');
114
996b0fd9
CS
115 $mform->addElement('passwordunmask', 'password', get_string('password', 'lti'));
116 $mform->setType('password', PARAM_TEXT);
117 $mform->setAdvanced('password');
b26dc53c 118 $mform->addHelpButton('password', 'password', 'lti');
996b0fd9
CS
119
120 $mform->addElement('textarea', 'instructorcustomparameters', get_string('custom', 'lti'), array('rows'=>4, 'cols'=>60));
121 $mform->setType('instructorcustomparameters', PARAM_TEXT);
122 $mform->setAdvanced('instructorcustomparameters');
b26dc53c 123 $mform->addHelpButton('instructorcustomparameters', 'custom', 'lti');
996b0fd9 124
996b0fd9
CS
125//-------------------------------------------------------------------------------
126 // Add privacy preferences fieldset where users choose whether to send their data
127 $mform->addElement('header', 'privacy', get_string('privacy', 'lti'));
128
129 $mform->addElement('checkbox', 'instructorchoicesendname', '&nbsp;', ' ' . get_string('share_name', 'lti'));
130 $mform->setDefault('instructorchoicesendname', '1');
b26dc53c 131 $mform->addHelpButton('instructorchoicesendname', 'share_name', 'lti');
996b0fd9
CS
132
133 $mform->addElement('checkbox', 'instructorchoicesendemailaddr', '&nbsp;', ' ' . get_string('share_email', 'lti'));
134 $mform->setDefault('instructorchoicesendemailaddr', '1');
b26dc53c 135 $mform->addHelpButton('instructorchoicesendemailaddr', 'share_email', 'lti');
996b0fd9
CS
136
137 $mform->addElement('checkbox', 'instructorchoiceacceptgrades', '&nbsp;', ' ' . get_string('accept_grades', 'lti'));
138 $mform->setDefault('instructorchoiceacceptgrades', '1');
b26dc53c 139 $mform->addHelpButton('instructorchoiceacceptgrades', 'accept_grades', 'lti');
996b0fd9
CS
140
141 $mform->addElement('checkbox', 'instructorchoiceallowroster', '&nbsp;', ' ' . get_string('share_roster', 'lti'));
142 $mform->setDefault('instructorchoiceallowroster', '1');
b26dc53c
CS
143 $mform->addHelpButton('instructorchoiceallowroster', 'share_roster', 'lti');
144
996b0fd9
CS
145//-------------------------------------------------------------------------------
146
147/* $debugoptions=array();
148 $debugoptions[0] = get_string('debuglaunchoff', 'lti');
149 $debugoptions[1] = get_string('debuglaunchon', 'lti');
150
151 $mform->addElement('select', 'debuglaunch', get_string('debuglaunch', 'lti'), $debugoptions);
152
153 if (isset($this->typeconfig['debuglaunch'])) {
154 if ($this->typeconfig['debuglaunch'] == 0) {
155 $mform->setDefault('debuglaunch', '0');
156 } else if ($this->typeconfig['debuglaunch'] == 1) {
157 $mform->setDefault('debuglaunch', '1');
158 }
159 }
160*/
161
162//-------------------------------------------------------------------------------
163 // add standard elements, common to all modules
164 $this->standard_coursemodule_elements();
165
166 $mform->setAdvanced('cmidnumber');
167//-------------------------------------------------------------------------------
168 // add standard buttons, common to all modules
169 $this->add_action_buttons();
170
6831c7cd
CS
171 $editurl = new moodle_url("/mod/lti/instructor_edit_tool_type.php?sesskey={$USER->sesskey}&course={$COURSE->id}");
172 $ajaxurl = new moodle_url('/mod/lti/ajax.php');
173
996b0fd9
CS
174 $jsinfo = (object)array(
175 'edit_icon_url' => (string)$OUTPUT->pix_url('t/edit'),
176 'add_icon_url' => (string)$OUTPUT->pix_url('t/add'),
177 'delete_icon_url' => (string)$OUTPUT->pix_url('t/delete'),
6831c7cd 178 'green_check_icon_url' => (string)$OUTPUT->pix_url('i/tick_green_small'),
16e8f130 179 'warning_icon_url' => (string)$OUTPUT->pix_url('warning', 'lti'),
6831c7cd
CS
180 'instructor_tool_type_edit_url' => $editurl->out(false),
181 'ajax_url' => $ajaxurl->out(true),
182 'courseId' => $COURSE->id
996b0fd9
CS
183 );
184
185 $module = array(
186 'name' => 'mod_lti_edit',
187 'fullpath' => '/mod/lti/mod_form.js',
6831c7cd
CS
188 'requires' => array('base', 'io', 'querystring-stringify-simple', 'node', 'event', 'json-parse'),
189 'strings' => array(
190 array('addtype', 'lti'),
191 array('edittype', 'lti'),
192 array('deletetype', 'lti'),
193 array('delete_confirmation', 'lti'),
194 array('cannot_edit', 'lti'),
195 array('cannot_delete', 'lti'),
196 array('global_tool_types', 'lti'),
16e8f130
CS
197 array('course_tool_types', 'lti'),
198 array('using_tool_configuration', 'lti'),
199 array('domain_mismatch', 'lti'),
200 array('custom_config', 'lti'),
201 array('tool_config_not_found', 'lti')
6831c7cd 202 ),
996b0fd9
CS
203 );
204
205 $PAGE->requires->js_init_call('M.mod_lti.editor.init', array(json_encode($jsinfo)), true, $module);
206 }
207
208 /**
209 * Make fields editable or non-editable depending on the administrator choices
210 * @see moodleform_mod::definition_after_data()
211 */
212 function definition_after_data() {
213 parent::definition_after_data();
214
215 }
216
217 /**
218 * Function overwritten to change default values using
219 * global configuration
220 *
221 * @param array $default_values passed by reference
222 */
223 function data_preprocessing(&$default_values) {
224
225 }
226}
227