156f5fe6766bfa179268b70db1d43fcb857dd8fc
[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);
33 $url = new moodle_url('/mod/data/templates.php');
34 if ($mode !== 'singletemplate') {
35     $url->param('mode', $mode);
36 }
38 if ($id) {
39     $url->param('id', $id);
40     $PAGE->set_url($url);
41     if (! $cm = get_coursemodule_from_id('data', $id)) {
42         print_error('invalidcoursemodule');
43     }
44     if (! $course = $DB->get_record('course', array('id'=>$cm->course))) {
45         print_error('coursemisconf');
46     }
47     if (! $data = $DB->get_record('data', array('id'=>$cm->instance))) {
48         print_error('invalidcoursemodule');
49     }
51 } else {
52     $url->param('d', $d);
53     $PAGE->set_url($url);
54     if (! $data = $DB->get_record('data', array('id'=>$d))) {
55         print_error('invalidid', 'data');
56     }
57     if (! $course = $DB->get_record('course', array('id'=>$data->course))) {
58         print_error('coursemisconf');
59     }
60     if (! $cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
61         print_error('invalidcoursemodule');
62     }
63 }
65 require_login($course->id, false, $cm);
67 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
68 require_capability('mod/data:managetemplates', $context);
70 if (!$DB->count_records('data_fields', array('dataid'=>$data->id))) {      // Brand new database!
71     redirect($CFG->wwwroot.'/mod/data/field.php?d='.$data->id);  // Redirect to field entry
72 }
74 add_to_log($course->id, 'data', 'templates view', "templates.php?id=$cm->id&amp;d=$data->id", $data->id, $cm->id);
77 /// Print the page header
79 $strdata = get_string('modulenameplural','data');
81 // For the javascript for inserting template tags: initialise the default textarea to
82 // 'edit_template' - it is always present in all different possible views.
84 $editorobj = 'editor_'.md5('template');
86 $bodytag = 'onload="';
87 $bodytag .= 'if (typeof('.$editorobj.') != \'undefined\') { currEditor = '.$editorobj.'; } ';
88 $bodytag .= 'currTextarea = document.getElementById(\'tempform\').template;';
89 $bodytag .= '" ';
91 if ($mode == 'singletemplate') {
92     $PAGE->navbar->add(get_string($mode,'data'));
93 }
95 $PAGE->requires->js('/mod/data/data.js');
96 $PAGE->set_title($data->name);
97 $PAGE->set_heading($course->fullname);
98 echo $OUTPUT->header();
99 echo $OUTPUT->heading(format_string($data->name));
102 /// Groups needed for Add entry tab
103 $currentgroup = groups_get_activity_group($cm);
104 $groupmode = groups_get_activity_groupmode($cm);
106 /// Print the tabs.
107 $currenttab = 'templates';
108 include('tabs.php');
110 /// Processing submitted data, i.e updating form.
111 $resettemplate = false;
113 if (($mytemplate = data_submitted()) && confirm_sesskey()) {
114     $newtemplate->id = $data->id;
115     $newtemplate->{$mode} = $mytemplate->template;
117     if (!empty($mytemplate->defaultform)) {
118         // Reset the template to default, but don't save yet.
119         $resettemplate = true;
120         $data->{$mode} = data_generate_default_template($data, $mode, 0, false, false);
121         if ($mode == 'listtemplate') {
122             $data->listtemplateheader = '';
123             $data->listtemplatefooter = '';
124         }
125     } else {
126         if (isset($mytemplate->listtemplateheader)){
127             $newtemplate->listtemplateheader = $mytemplate->listtemplateheader;
128         }
129         if (isset($mytemplate->listtemplatefooter)){
130             $newtemplate->listtemplatefooter = $mytemplate->listtemplatefooter;
131         }
132         if (isset($mytemplate->rsstitletemplate)){
133             $newtemplate->rsstitletemplate = $mytemplate->rsstitletemplate;
134         }
136         // Check for multiple tags, only need to check for add template.
137         if ($mode != 'addtemplate' or data_tags_check($data->id, $newtemplate->{$mode})) {
138             if ($DB->update_record('data', $newtemplate)) {
139                 echo $OUTPUT->notification(get_string('templatesaved', 'data'), 'notifysuccess');
140             }
141         }
142         add_to_log($course->id, 'data', 'templates saved', "templates.php?id=$cm->id&amp;d=$data->id", $data->id, $cm->id);
143     }
144 } else {
145     echo '<div class="littleintro" style="text-align:center">'.get_string('header'.$mode,'data').'</div>';
148 /// If everything is empty then generate some defaults
149 if (empty($data->addtemplate) and empty($data->singletemplate) and
150     empty($data->listtemplate) and empty($data->rsstemplate)) {
151     data_generate_default_template($data, 'singletemplate');
152     data_generate_default_template($data, 'listtemplate');
153     data_generate_default_template($data, 'addtemplate');
154     data_generate_default_template($data, 'asearchtemplate');           //Template for advanced searches.
155     data_generate_default_template($data, 'rsstemplate');
158 editors_head_setup();
159 $format = FORMAT_HTML;
160 $editor = editors_get_preferred_editor($format);
161 $strformats = format_text_menu();
162 $formats =  $editor->get_supported_formats();
163 foreach ($formats as $fid) {
164     $formats[$fid] = $strformats[$fid];
166 $options = array();
167 $options['trusttext'] = false;
168 $options['forcehttps'] = false;
169 $options['subdirs'] = false;
170 $options['maxfiles'] = 0;
171 $options['maxbytes'] = 0;
172 $options['changeformat'] = 0;
173 $options['noclean'] = false;
175 echo '<form id="tempform" action="templates.php?d='.$data->id.'&amp;mode='.$mode.'" method="post">';
176 echo '<div>';
177 echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />';
178 // Print button to autogen all forms, if all templates are empty
180 if (!$resettemplate) {
181     // Only reload if we are not resetting the template to default.
182     $data = $DB->get_record('data', array('id'=>$d));
184 echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
185 echo '<table cellpadding="4" cellspacing="0" border="0">';
187 /// Add the HTML editor(s).
188 $usehtmleditor = can_use_html_editor() && ($mode != 'csstemplate') && ($mode != 'jstemplate');
189 if ($mode == 'listtemplate'){
190     // Print the list template header.
191     echo '<tr>';
192     echo '<td>&nbsp;</td>';
193     echo '<td>';
194     echo '<div style="text-align:center"><label for="edit-listtemplateheader">'.get_string('header','data').'</label></div>';
196     $field = 'listtemplateheader';
197     $editor->use_editor($field, $options);
198     echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->listtemplateheader).'</textarea></div>';
200     echo '</td>';
201     echo '</tr>';
204 // Print the main template.
206 echo '<tr><td valign="top">';
207 if ($mode != 'csstemplate' and $mode != 'jstemplate') {
208     // Add all the available fields for this data.
209     echo '<label for="availabletags">'.get_string('availabletags','data').'</label>';
210     echo $OUTPUT->help_icon('availabletags', 'data');
211     echo '<br />';
214     echo '<select name="fields1[]" id="availabletags" size="12" onclick="insert_field_tags(this)">';
216     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
217     echo '<optgroup label="'.get_string('fields', 'data').'">';
218     foreach ($fields as $field) {
219         echo '<option value="[['.$field->name.']]" title="'.$field->description.'">'.$field->name.' - [['.$field->name.']]</option>';
220     }
221     echo '</optgroup>';
223     if ($mode == 'addtemplate') {
224         echo '<optgroup label="'.get_string('fieldids', 'data').'">';
225         foreach ($fields as $field) {
226             if (in_array($field->type, array('picture', 'checkbox', 'date', 'latlong', 'radiobutton'))) {
227                 continue; //ids are not usable for these composed items
228             }
229             echo '<option value="[['.$field->name.'#id]]" title="'.$field->description.' id">'.$field->name.' id - [['.$field->name.'#id]]</option>';
230         }
231         echo '</optgroup>';
232     }
234     // Print special tags. fix for MDL-7031
235     if ($mode != 'addtemplate' && $mode != 'asearchtemplate') {             //Don't print special tags when viewing the advanced search template and add template.
236         echo '<optgroup label="'.get_string('buttons', 'data').'">';
237         echo '<option value="##edit##">' .get_string('edit', 'data'). ' - ##edit##</option>';
238         echo '<option value="##delete##">' .get_string('delete', 'data'). ' - ##delete##</option>';
239         echo '<option value="##approve##">' .get_string('approve', 'data'). ' - ##approve##</option>';
240         if ($mode != 'rsstemplate') {
241             echo '<option value="##export##">' .get_string('export', 'data'). ' - ##export##</option>';
242         }
243         if ($mode != 'singletemplate') {
244             // more points to single template - not useable there
245             echo '<option value="##more##">' .get_string('more', 'data'). ' - ##more##</option>';
246             echo '<option value="##moreurl##">' .get_string('moreurl', 'data'). ' - ##moreurl##</option>';
247         }
248         echo '</optgroup>';
249         echo '<optgroup label="'.get_string('other', 'data').'">';
250         echo '<option value="##timeadded##">'.get_string('timeadded', 'data'). ' - ##timeadded##</option>';
251         echo '<option value="##timemodified##">'.get_string('timemodified', 'data'). ' - ##timemodified##</option>';
252         echo '<option value="##user##">' .get_string('user'). ' - ##user##</option>';
253         if ($mode != 'singletemplate') {
254             // more points to single template - not useable there
255             echo '<option value="##comments##">' .get_string('comments', 'data'). ' - ##comments##</option>';
256         }
257         echo '</optgroup>';
258     }
260     if ($mode == 'asearchtemplate') {
261         echo '<optgroup label="'.get_string('other', 'data').'">';
262         echo '<option value="##firstname##">' .get_string('authorfirstname', 'data'). ' - ##firstname##</option>';
263         echo '<option value="##lastname##">' .get_string('authorlastname', 'data'). ' - ##lastname##</option>';
264         echo '</optgroup>';
265     }
267     echo '</select>';
268     echo '<br /><br /><br /><br /><input type="submit" name="defaultform" value="'.get_string('resettemplate','data').'" />';
269     if (can_use_html_editor()) {
270         echo '<br /><br />';
271         if ($usehtmleditor) {
272             $switcheditor = get_string('editordisable', 'data');
273         } else {
274             $switcheditor = get_string('editorenable', 'data');
275         }
276         echo '<input type="submit" name="switcheditor" value="'.s($switcheditor).'" />';
277     }
278 } else {
279     echo '<br /><br /><br /><br /><input type="submit" name="defaultform" value="'.get_string('resettemplate','data').'" />';
281 echo '</td>';
283 echo '<td valign="top">';
284 if ($mode == 'listtemplate'){
285     echo '<div style="text-align:center"><label for="edit-template">'.get_string('multientry','data').'</label></div>';
286 } else {
287     echo '<div style="text-align:center"><label for="edit-template">'.get_string($mode,'data').'</label></div>';
290 $field = 'template';
291 $editor->use_editor($field, $options);
292 echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->{$mode}).'</textarea></div>';
293 echo '</td>';
294 echo '</tr>';
296 if ($mode == 'listtemplate'){
297     echo '<tr>';
298     echo '<td>&nbsp;</td>';
299     echo '<td>';
300     echo '<div style="text-align:center"><label for="edit-listtemplatefooter">'.get_string('footer','data').'</label></div>';
302     $field = 'listtemplatefooter';
303     $editor->use_editor($field, $options);
304     echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->listtemplatefooter).'</textarea></div>';
305     echo '</td>';
306     echo '</tr>';
307 } else if ($mode == 'rsstemplate') {
308     echo '<tr>';
309     echo '<td>&nbsp;</td>';
310     echo '<td>';
311     echo '<div style="text-align:center"><label for="edit-rsstitletemplate">'.get_string('rsstitletemplate','data').'</label></div>';
313     $field = 'rsstitletemplate';
314     $editor->use_editor($field, $options);
315     echo '<div><textarea id="'.$field.'" name="'.$field.'" rows="15" cols="80">'.s($data->rsstitletemplate).'</textarea></div>';
316     echo '</td>';
317     echo '</tr>';
320 echo '<tr><td style="text-align:center" colspan="2">';
321 echo '<input type="submit" value="'.get_string('savetemplate','data').'" />&nbsp;';
323 echo '</td></tr></table>';
326 echo $OUTPUT->box_end();
327 echo '</div>';
328 echo '</form>';
330 /// Finish the page
331 echo $OUTPUT->footer();