MDL-31496 mod_data Replacing inline styles for CSS classes in templates and browse...
[moodle.git] / mod / data / templates.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file is part of the Database module for Moodle
20  *
21  * @copyright 2005 Martin Dougiamas  http://dougiamas.com
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package mod-data
24  */
26 require_once('../../config.php');
27 require_once('lib.php');
29 $id    = optional_param('id', 0, PARAM_INT);  // course module id
30 $d     = optional_param('d', 0, PARAM_INT);   // database id
31 $mode  = optional_param('mode', 'singletemplate', PARAM_ALPHA);
32 $disableeditor = optional_param('switcheditor', false, PARAM_RAW);
33 $enableeditor = optional_param('useeditor', false, PARAM_RAW);
35 $url = new moodle_url('/mod/data/templates.php');
36 if ($mode !== 'singletemplate') {
37     $url->param('mode', $mode);
38 }
40 if ($id) {
41     $url->param('id', $id);
42     $PAGE->set_url($url);
43     if (! $cm = get_coursemodule_from_id('data', $id)) {
44         print_error('invalidcoursemodule');
45     }
46     if (! $course = $DB->get_record('course', array('id'=>$cm->course))) {
47         print_error('coursemisconf');
48     }
49     if (! $data = $DB->get_record('data', array('id'=>$cm->instance))) {
50         print_error('invalidcoursemodule');
51     }
53 } else {
54     $url->param('d', $d);
55     $PAGE->set_url($url);
56     if (! $data = $DB->get_record('data', array('id'=>$d))) {
57         print_error('invalidid', 'data');
58     }
59     if (! $course = $DB->get_record('course', array('id'=>$data->course))) {
60         print_error('coursemisconf');
61     }
62     if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
63         print_error('invalidcoursemodule');
64     }
65 }
67 require_login($course, false, $cm);
69 $context = context_module::instance($cm->id);
70 require_capability('mod/data:managetemplates', $context);
72 if (!$DB->count_records('data_fields', array('dataid'=>$data->id))) {      // Brand new database!
73     redirect($CFG->wwwroot.'/mod/data/field.php?d='.$data->id);  // Redirect to field entry
74 }
76 add_to_log($course->id, 'data', 'templates view', "templates.php?id=$cm->id&amp;d=$data->id", $data->id, $cm->id);
79 /// Print the page header
81 $strdata = get_string('modulenameplural','data');
83 // For the javascript for inserting template tags: initialise the default textarea to
84 // 'edit_template' - it is always present in all different possible views.
86 if ($mode == 'singletemplate') {
87     $PAGE->navbar->add(get_string($mode,'data'));
88 }
90 $PAGE->requires->js('/mod/data/data.js');
91 $PAGE->set_title($data->name);
92 $PAGE->set_heading($course->fullname);
93 $PAGE->set_pagelayout('report');
94 echo $OUTPUT->header();
95 echo $OUTPUT->heading(format_string($data->name));
98 /// Groups needed for Add entry tab
99 $currentgroup = groups_get_activity_group($cm);
100 $groupmode = groups_get_activity_groupmode($cm);
102 /// Print the tabs.
103 $currenttab = 'templates';
104 include('tabs.php');
106 /// Processing submitted data, i.e updating form.
107 $resettemplate = false;
109 if (($mytemplate = data_submitted()) && confirm_sesskey()) {
110     $newtemplate = new stdClass();
111     $newtemplate->id = $data->id;
112     $newtemplate->{$mode} = $mytemplate->template;
114     if (!empty($mytemplate->defaultform)) {
115         // Reset the template to default, but don't save yet.
116         $resettemplate = true;
117         $data->{$mode} = data_generate_default_template($data, $mode, 0, false, false);
118         if ($mode == 'listtemplate') {
119             $data->listtemplateheader = '';
120             $data->listtemplatefooter = '';
121         }
122     } else {
123         if (isset($mytemplate->listtemplateheader)){
124             $newtemplate->listtemplateheader = $mytemplate->listtemplateheader;
125         }
126         if (isset($mytemplate->listtemplatefooter)){
127             $newtemplate->listtemplatefooter = $mytemplate->listtemplatefooter;
128         }
129         if (isset($mytemplate->rsstitletemplate)){
130             $newtemplate->rsstitletemplate = $mytemplate->rsstitletemplate;
131         }
133         // Check for multiple tags, only need to check for add template.
134         if ($mode != 'addtemplate' or data_tags_check($data->id, $newtemplate->{$mode})) {
135             // if disableeditor or enableeditor buttons click, don't save instance
136             if (empty($disableeditor) && empty($enableeditor)) {
137                 $DB->update_record('data', $newtemplate);
138                 echo $OUTPUT->notification(get_string('templatesaved', 'data'), 'notifysuccess');
139                 add_to_log($course->id, 'data', 'templates saved', "templates.php?id=$cm->id&amp;d=$data->id", $data->id, $cm->id);
140             }
141         }
142     }
143 } else {
144     echo '<div class="template_heading">'.get_string('header'.$mode,'data').'</div>';
147 /// If everything is empty then generate some defaults
148 if (empty($data->addtemplate) and empty($data->singletemplate) and
149     empty($data->listtemplate) and empty($data->rsstemplate)) {
150     data_generate_default_template($data, 'singletemplate');
151     data_generate_default_template($data, 'listtemplate');
152     data_generate_default_template($data, 'addtemplate');
153     data_generate_default_template($data, 'asearchtemplate');           //Template for advanced searches.
154     data_generate_default_template($data, 'rsstemplate');
157 editors_head_setup();
158 $format = FORMAT_HTML;
160 if ($mode === 'csstemplate' or $mode === 'jstemplate') {
161     $disableeditor = true;
164 if ($disableeditor) {
165     $format = FORMAT_PLAIN;
167 $editor = editors_get_preferred_editor($format);
168 $strformats = format_text_menu();
169 $formats =  $editor->get_supported_formats();
170 foreach ($formats as $fid) {
171     $formats[$fid] = $strformats[$fid];
173 $options = array();
174 $options['trusttext'] = false;
175 $options['forcehttps'] = false;
176 $options['subdirs'] = false;
177 $options['maxfiles'] = 0;
178 $options['maxbytes'] = 0;
179 $options['changeformat'] = 0;
180 $options['noclean'] = false;
182 echo '<form id="tempform" action="templates.php?d='.$data->id.'&amp;mode='.$mode.'" method="post">';
183 echo '<div>';
184 echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />';
185 // Print button to autogen all forms, if all templates are empty
187 if (!$resettemplate) {
188     // Only reload if we are not resetting the template to default.
189     $data = $DB->get_record('data', array('id'=>$d));
191 echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
192 echo '<table cellpadding="4" cellspacing="0" border="0">';
194 /// Add the HTML editor(s).
195 $usehtmleditor = can_use_html_editor() && ($mode != 'csstemplate') && ($mode != 'jstemplate') && !$disableeditor;
196 if ($mode == 'listtemplate'){
197     // Print the list template header.
198     echo '<tr>';
199     echo '<td>&nbsp;</td>';
200     echo '<td>';
201     echo '<div class="template_heading"><label for="edit-listtemplateheader">'.get_string('header','data').'</label></div>';
203     $field = 'listtemplateheader';
204     $editor->use_editor($field, $options);
205     echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->listtemplateheader).'</textarea></div>';
207     echo '</td>';
208     echo '</tr>';
211 // Print the main template.
213 echo '<tr><td valign="top">';
214 if ($mode != 'csstemplate' and $mode != 'jstemplate') {
215     // Add all the available fields for this data.
216     echo '<label for="availabletags">'.get_string('availabletags','data').'</label>';
217     echo $OUTPUT->help_icon('availabletags', 'data');
218     echo '<br />';
221     echo '<select name="fields1[]" id="availabletags" size="12" onclick="insert_field_tags(this)">';
223     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
224     echo '<optgroup label="'.get_string('fields', 'data').'">';
225     foreach ($fields as $field) {
226         echo '<option value="[['.$field->name.']]" title="'.$field->description.'">'.$field->name.' - [['.$field->name.']]</option>';
227     }
228     echo '</optgroup>';
230     if ($mode == 'addtemplate') {
231         echo '<optgroup label="'.get_string('fieldids', 'data').'">';
232         foreach ($fields as $field) {
233             if (in_array($field->type, array('picture', 'checkbox', 'date', 'latlong', 'radiobutton'))) {
234                 continue; //ids are not usable for these composed items
235             }
236             echo '<option value="[['.$field->name.'#id]]" title="'.$field->description.' id">'.$field->name.' id - [['.$field->name.'#id]]</option>';
237         }
238         echo '</optgroup>';
239     }
241     // Print special tags. fix for MDL-7031
242     if ($mode != 'addtemplate' && $mode != 'asearchtemplate') {             //Don't print special tags when viewing the advanced search template and add template.
243         echo '<optgroup label="'.get_string('buttons', 'data').'">';
244         echo '<option value="##edit##">' .get_string('edit', 'data'). ' - ##edit##</option>';
245         echo '<option value="##delete##">' .get_string('delete', 'data'). ' - ##delete##</option>';
246         echo '<option value="##approve##">' .get_string('approve', 'data'). ' - ##approve##</option>';
247         if ($mode != 'rsstemplate') {
248             echo '<option value="##export##">' .get_string('export', 'data'). ' - ##export##</option>';
249         }
250         if ($mode != 'singletemplate') {
251             // more points to single template - not useable there
252             echo '<option value="##more##">' .get_string('more', 'data'). ' - ##more##</option>';
253             echo '<option value="##moreurl##">' .get_string('moreurl', 'data'). ' - ##moreurl##</option>';
254         }
255         echo '</optgroup>';
256         echo '<optgroup label="'.get_string('other', 'data').'">';
257         echo '<option value="##timeadded##">'.get_string('timeadded', 'data'). ' - ##timeadded##</option>';
258         echo '<option value="##timemodified##">'.get_string('timemodified', 'data'). ' - ##timemodified##</option>';
259         echo '<option value="##user##">' .get_string('user'). ' - ##user##</option>';
260         if ($mode != 'singletemplate') {
261             // more points to single template - not useable there
262             echo '<option value="##comments##">' .get_string('comments', 'data'). ' - ##comments##</option>';
263         }
264         echo '</optgroup>';
265     }
267     if ($mode == 'asearchtemplate') {
268         echo '<optgroup label="'.get_string('other', 'data').'">';
269         echo '<option value="##firstname##">' .get_string('authorfirstname', 'data'). ' - ##firstname##</option>';
270         echo '<option value="##lastname##">' .get_string('authorlastname', 'data'). ' - ##lastname##</option>';
271         echo '</optgroup>';
272     }
274     echo '</select>';
275     echo '<br /><br /><br /><br /><input type="submit" name="defaultform" value="'.get_string('resettemplate','data').'" />';
276     if (can_use_html_editor()) {
277         echo '<br /><br />';
278         if ($usehtmleditor) {
279             $switcheditor = get_string('editordisable', 'data');
280             echo '<input type="submit" name="switcheditor" value="'.s($switcheditor).'" />';
281         } else {
282             $switcheditor = get_string('editorenable', 'data');
283             echo '<input type="submit" name="useeditor" value="'.s($switcheditor).'" />';
284         }
285     }
286 } else {
287     echo '<br /><br /><br /><br /><input type="submit" name="defaultform" value="'.get_string('resettemplate','data').'" />';
289 echo '</td>';
291 echo '<td valign="top">';
292 if ($mode == 'listtemplate'){
293     echo '<div class="template_heading"><label for="edit-template">'.get_string('multientry','data').'</label></div>';
294 } else {
295     echo '<div class="template_heading"><label for="edit-template">'.get_string($mode,'data').'</label></div>';
298 $field = 'template';
299 $editor->use_editor($field, $options);
300 echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->{$mode}).'</textarea></div>';
301 echo '</td>';
302 echo '</tr>';
304 if ($mode == 'listtemplate'){
305     echo '<tr>';
306     echo '<td>&nbsp;</td>';
307     echo '<td>';
308     echo '<div class="template_heading"><label for="edit-listtemplatefooter">'.get_string('footer','data').'</label></div>';
310     $field = 'listtemplatefooter';
311     $editor->use_editor($field, $options);
312     echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->listtemplatefooter).'</textarea></div>';
313     echo '</td>';
314     echo '</tr>';
315 } else if ($mode == 'rsstemplate') {
316     echo '<tr>';
317     echo '<td>&nbsp;</td>';
318     echo '<td>';
319     echo '<div class="template_heading"><label for="edit-rsstitletemplate">'.get_string('rsstitletemplate','data').'</label></div>';
321     $field = 'rsstitletemplate';
322     $editor->use_editor($field, $options);
323     echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->rsstitletemplate).'</textarea></div>';
324     echo '</td>';
325     echo '</tr>';
328 echo '<tr><td class="save_template" colspan="2">';
329 echo '<input type="submit" value="'.get_string('savetemplate','data').'" />&nbsp;';
331 echo '</td></tr></table>';
334 echo $OUTPUT->box_end();
335 echo '</div>';
336 echo '</form>';
338 /// Finish the page
339 echo $OUTPUT->footer();