12d8b783be5f319a019303a5d9f7458fbc41bba7
[moodle.git] / mod / data / lib.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  * @package   mod-data
20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 // Some constants
25 define ('DATA_MAX_ENTRIES', 50);
26 define ('DATA_PERPAGE_SINGLE', 1);
28 define ('DATA_FIRSTNAME', -1);
29 define ('DATA_LASTNAME', -2);
30 define ('DATA_APPROVED', -3);
31 define ('DATA_TIMEADDED', 0);
32 define ('DATA_TIMEMODIFIED', -4);
34 define ('DATA_CAP_EXPORT', 'mod/data:viewalluserpresets');
35 // Users having assigned the default role "Non-editing teacher" can export database records
36 // Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
37 // In Moodle >= 2, new roles may be introduced and used instead.
39 /**
40  * @package   mod-data
41  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
42  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class data_field_base {     // Base class for Database Field Types (see field/*/field.class.php)
46     /** @var string Subclasses must override the type with their name */
47     var $type = 'unknown';
48     /** @var object The database object that this field belongs to */
49     var $data = NULL;
50     /** @var object The field object itself, if we know it */
51     var $field = NULL;
52     /** @var int Width of the icon for this fieldtype */
53     var $iconwidth = 16;
54     /** @var int Width of the icon for this fieldtype */
55     var $iconheight = 16;
56     /** @var object course module or cmifno */
57     var $cm;
58     /** @var object activity context */
59     var $context;
61     /**
62      * Constructor function
63      *
64      * @global object
65      * @uses CONTEXT_MODULE
66      * @param int $field
67      * @param int $data
68      * @param int $cm
69      */
70     function __construct($field=0, $data=0, $cm=0) {   // Field or data or both, each can be id or object
71         global $DB;
73         if (empty($field) && empty($data)) {
74             print_error('missingfield', 'data');
75         }
77         if (!empty($field)) {
78             if (is_object($field)) {
79                 $this->field = $field;  // Programmer knows what they are doing, we hope
80             } else if (!$this->field = $DB->get_record('data_fields', array('id'=>$field))) {
81                 print_error('invalidfieldid', 'data');
82             }
83             if (empty($data)) {
84                 if (!$this->data = $DB->get_record('data', array('id'=>$this->field->dataid))) {
85                     print_error('invalidid', 'data');
86                 }
87             }
88         }
90         if (empty($this->data)) {         // We need to define this properly
91             if (!empty($data)) {
92                 if (is_object($data)) {
93                     $this->data = $data;  // Programmer knows what they are doing, we hope
94                 } else if (!$this->data = $DB->get_record('data', array('id'=>$data))) {
95                     print_error('invalidid', 'data');
96                 }
97             } else {                      // No way to define it!
98                 print_error('missingdata', 'data');
99             }
100         }
102         if ($cm) {
103             $this->cm = $cm;
104         } else {
105             $this->cm = get_coursemodule_from_instance('data', $this->data->id);
106         }
108         if (empty($this->field)) {         // We need to define some default values
109             $this->define_default_field();
110         }
112         $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
113     }
116     /**
117      * This field just sets up a default field object
118      *
119      * @return bool
120      */
121     function define_default_field() {
122         global $OUTPUT;
123         if (empty($this->data->id)) {
124             echo $OUTPUT->notification('Programmer error: dataid not defined in field class');
125         }
126         $this->field = new object;
127         $this->field->id = 0;
128         $this->field->dataid = $this->data->id;
129         $this->field->type   = $this->type;
130         $this->field->param1 = '';
131         $this->field->param2 = '';
132         $this->field->param3 = '';
133         $this->field->name = '';
134         $this->field->description = '';
136         return true;
137     }
139     /**
140      * Set up the field object according to data in an object.  Now is the time to clean it!
141      *
142      * @return bool
143      */
144     function define_field($data) {
145         $this->field->type        = $this->type;
146         $this->field->dataid      = $this->data->id;
148         $this->field->name        = trim($data->name);
149         $this->field->description = trim($data->description);
151         if (isset($data->param1)) {
152             $this->field->param1 = trim($data->param1);
153         }
154         if (isset($data->param2)) {
155             $this->field->param2 = trim($data->param2);
156         }
157         if (isset($data->param3)) {
158             $this->field->param3 = trim($data->param3);
159         }
160         if (isset($data->param4)) {
161             $this->field->param4 = trim($data->param4);
162         }
163         if (isset($data->param5)) {
164             $this->field->param5 = trim($data->param5);
165         }
167         return true;
168     }
170     /**
171      * Insert a new field in the database
172      * We assume the field object is already defined as $this->field
173      *
174      * @global object
175      * @return bool
176      */
177     function insert_field() {
178         global $DB, $OUTPUT;
180         if (empty($this->field)) {
181             echo $OUTPUT->notification('Programmer error: Field has not been defined yet!  See define_field()');
182             return false;
183         }
185         $this->field->id = $DB->insert_record('data_fields',$this->field);
186         return true;
187     }
190     /**
191      * Update a field in the database
192      *
193      * @global object
194      * @return bool
195      */
196     function update_field() {
197         global $DB;
199         $DB->update_record('data_fields', $this->field);
200         return true;
201     }
203     /**
204      * Delete a field completely
205      *
206      * @global object
207      * @return bool
208      */
209     function delete_field() {
210         global $DB;
212         if (!empty($this->field->id)) {
213             $this->delete_content();
214             $DB->delete_records('data_fields', array('id'=>$this->field->id));
215         }
216         return true;
217     }
219     /**
220      * Print the relevant form element in the ADD template for this field
221      *
222      * @global object
223      * @param int $recordid
224      * @return string
225      */
226     function display_add_field($recordid=0){
227         global $DB;
229         if ($recordid){
230             $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
231         } else {
232             $content = '';
233         }
235         // beware get_field returns false for new, empty records MDL-18567
236         if ($content===false) {
237             $content='';
238         }
240         $str = '<div title="'.s($this->field->description).'">';
241         $str .= '<input style="width:300px;" type="text" name="field_'.$this->field->id.'" id="field_'.$this->field->id.'" value="'.s($content).'" />';
242         $str .= '</div>';
244         return $str;
245     }
247     /**
248      * Print the relevant form element to define the attributes for this field
249      * viewable by teachers only.
250      *
251      * @global object
252      * @global object
253      * @return void Output is echo'd
254      */
255     function display_edit_field() {
256         global $CFG, $DB, $OUTPUT;
258         if (empty($this->field)) {   // No field has been defined yet, try and make one
259             $this->define_default_field();
260         }
261         echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
263         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
264         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
265         if (empty($this->field->id)) {
266             echo '<input type="hidden" name="mode" value="add" />'."\n";
267             $savebutton = get_string('add');
268         } else {
269             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
270             echo '<input type="hidden" name="mode" value="update" />'."\n";
271             $savebutton = get_string('savechanges');
272         }
273         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
274         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
276         echo $OUTPUT->heading($this->name());
278         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
280         echo '<div class="mdl-align">';
281         echo '<input type="submit" value="'.$savebutton.'" />'."\n";
282         echo '<input type="submit" name="cancel" value="'.get_string('cancel').'" />'."\n";
283         echo '</div>';
285         echo '</form>';
287         echo $OUTPUT->box_end();
288     }
290     /**
291      * Display the content of the field in browse mode
292      *
293      * @global object
294      * @param int $recordid
295      * @param object $template
296      * @return bool|string
297      */
298     function display_browse_field($recordid, $template) {
299         global $DB;
301         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
302             if (isset($content->content)) {
303                 $options = new object();
304                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
305                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
306                     //$content->content1 = FORMAT_HTML;
307                     $options->filter=false;
308                 }
309                 $options->para = false;
310                 $str = format_text($content->content, $content->content1, $options);
311             } else {
312                 $str = '';
313             }
314             return $str;
315         }
316         return false;
317     }
319     /**
320      * Update the content of one data field in the data_content table
321      * @global object
322      * @param int $recordid
323      * @param mixed $value
324      * @param string $name
325      * @return bool
326      */
327     function update_content($recordid, $value, $name=''){
328         global $DB;
330         $content = new object();
331         $content->fieldid = $this->field->id;
332         $content->recordid = $recordid;
333         $content->content = clean_param($value, PARAM_NOTAGS);
335         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
336             $content->id = $oldcontent->id;
337             return $DB->update_record('data_content', $content);
338         } else {
339             return $DB->insert_record('data_content', $content);
340         }
341     }
343     /**
344      * Delete all content associated with the field
345      *
346      * @global object
347      * @param int $recordid
348      * @return bool
349      */
350     function delete_content($recordid=0) {
351         global $DB;
353         if ($recordid) {
354             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
355         } else {
356             $conditions = array('fieldid'=>$this->field->id);
357         }
359         if ($rs = $DB->get_recordset('data_content', $conditions)) {
360             $fs = get_file_storage();
361             foreach ($rs as $content) {
362                 $fs->delete_area_files($this->context->id, 'mod_data', 'content', $content->id);
363             }
364             $rs->close();
365         }
367         return $DB->delete_records('data_content', $conditions);
368     }
370     /**
371      * Check if a field from an add form is empty
372      *
373      * @param mixed $value
374      * @param mixed $name
375      * @return bool
376      */
377     function notemptyfield($value, $name) {
378         return !empty($value);
379     }
381     /**
382      * Just in case a field needs to print something before the whole form
383      */
384     function print_before_form() {
385     }
387     /**
388      * Just in case a field needs to print something after the whole form
389      */
390     function print_after_form() {
391     }
394     /**
395      * Returns the sortable field for the content. By default, it's just content
396      * but for some plugins, it could be content 1 - content4
397      *
398      * @return string
399      */
400     function get_sort_field() {
401         return 'content';
402     }
404     /**
405      * Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
406      *
407      * @param string $fieldname
408      * @return string $fieldname
409      */
410     function get_sort_sql($fieldname) {
411         return $fieldname;
412     }
414     /**
415      * Returns the name/type of the field
416      *
417      * @return string
418      */
419     function name() {
420         return get_string('name'.$this->type, 'data');
421     }
423     /**
424      * Prints the respective type icon
425      *
426      * @global object
427      * @return string
428      */
429     function image() {
430         global $OUTPUT;
432         $params = array('d'=>$this->data->id, 'fid'=>$this->field->id, 'mode'=>'display', 'sesskey'=>sesskey());
433         $link = new moodle_url('/mod/data/field.php', $params);
434         $str = '<a href="'.$link->out().'">';
435         $str .= '<img src="'.$OUTPUT->pix_url('field/'.$this->type, 'data') . '" ';
436         $str .= 'height="'.$this->iconheight.'" width="'.$this->iconwidth.'" alt="'.$this->type.'" title="'.$this->type.'" /></a>';
437         return $str;
438     }
440     /**
441      * Per default, it is assumed that fields support text exporting.
442      * Override this (return false) on fields not supporting text exporting.
443      *
444      * @return bool true
445      */
446     function text_export_supported() {
447         return true;
448     }
450     /**
451      * Per default, return the record's text value only from the "content" field.
452      * Override this in fields class if necesarry.
453      *
454      * @param string $record
455      * @return string
456      */
457     function export_text_value($record) {
458         if ($this->text_export_supported()) {
459             return $record->content;
460         }
461     }
463     /**
464      * @param string $relativepath
465      * @return bool false
466      */
467     function file_ok($relativepath) {
468         return false;
469     }
473 /**
474  * Given a template and a dataid, generate a default case template
475  *
476  * @global object
477  * @param object $data
478  * @param string template [addtemplate, singletemplate, listtempalte, rsstemplate]
479  * @param int $recordid
480  * @param bool $form
481  * @param bool $update
482  * @return bool|string
483  */
484 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
485     global $DB;
487     if (!$data && !$template) {
488         return false;
489     }
490     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
491         return '';
492     }
494     // get all the fields for that database
495     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
497         $str = '<div class="defaulttemplate">';
498         $str .= '<table cellpadding="5">';
500         foreach ($fields as $field) {
502             $str .= '<tr><td valign="top" align="right">';
503             // Yu: commenting this out, the id was wrong and will fix later
504             //if ($template == 'addtemplate') {
505                 //$str .= '<label';
506                 //if (!in_array($field->type, array('picture', 'checkbox', 'date', 'latlong', 'radiobutton'))) {
507                 //    $str .= ' for="[['.$field->name.'#id]]"';
508                 //}
509                 //$str .= '>'.$field->name.'</label>';
511             //} else {
512                 $str .= $field->name.': ';
513             //}
514             $str .= '</td>';
516             $str .='<td  align="left">';
517             if ($form) {   // Print forms instead of data
518                 $fieldobj = data_get_field($field, $data);
519                 $str .= $fieldobj->display_add_field($recordid);
521             } else {           // Just print the tag
522                 $str .= '[['.$field->name.']]';
523             }
524             $str .= '</td></tr>';
526         }
527         if ($template == 'listtemplate') {
528             $str .= '<tr><td align="center" colspan="2">##edit##  ##more##  ##delete##  ##approve##  ##export##</td></tr>';
529         } else if ($template == 'singletemplate') {
530             $str .= '<tr><td align="center" colspan="2">##edit##  ##delete##  ##approve##  ##export##</td></tr>';
531         } else if ($template == 'asearchtemplate') {
532             $str .= '<tr><td valign="top" align="right">'.get_string('authorfirstname', 'data').': </td><td>##firstname##</td></tr>';
533             $str .= '<tr><td valign="top" align="right">'.get_string('authorlastname', 'data').': </td><td>##lastname##</td></tr>';
534         }
536         $str .= '</table>';
537         $str .= '</div>';
539         if ($template == 'listtemplate'){
540             $str .= '<hr />';
541         }
543         if ($update) {
544             $newdata = new object();
545             $newdata->id = $data->id;
546             $newdata->{$template} = $str;
547             $DB->update_record('data', $newdata);
548             $data->{$template} = $str;
549         }
551         return $str;
552     }
556 /**
557  * Search for a field name and replaces it with another one in all the
558  * form templates. Set $newfieldname as '' if you want to delete the
559  * field from the form.
560  *
561  * @global object
562  * @param object $data
563  * @param string $searchfieldname
564  * @param string $newfieldname
565  * @return bool
566  */
567 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
568     global $DB;
570     if (!empty($newfieldname)) {
571         $prestring = '[[';
572         $poststring = ']]';
573         $idpart = '#id';
575     } else {
576         $prestring = '';
577         $poststring = '';
578         $idpart = '';
579     }
581     $newdata = new object();
582     $newdata->id = $data->id;
583     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
584             $prestring.$newfieldname.$poststring, $data->singletemplate);
586     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
587             $prestring.$newfieldname.$poststring, $data->listtemplate);
589     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
590             $prestring.$newfieldname.$poststring, $data->addtemplate);
592     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
593             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
595     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
596             $prestring.$newfieldname.$poststring, $data->rsstemplate);
598     return $DB->update_record('data', $newdata);
602 /**
603  * Appends a new field at the end of the form template.
604  *
605  * @global object
606  * @param object $data
607  * @param string $newfieldname
608  */
609 function data_append_new_field_to_templates($data, $newfieldname) {
610     global $DB;
612     $newdata = new object();
613     $newdata->id = $data->id;
614     $change = false;
616     if (!empty($data->singletemplate)) {
617         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
618         $change = true;
619     }
620     if (!empty($data->addtemplate)) {
621         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
622         $change = true;
623     }
624     if (!empty($data->rsstemplate)) {
625         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
626         $change = true;
627     }
628     if ($change) {
629         $DB->update_record('data', $newdata);
630     }
634 /**
635  * given a field name
636  * this function creates an instance of the particular subfield class
637  *
638  * @global object
639  * @param string $name
640  * @param object $data
641  * @return object|bool
642  */
643 function data_get_field_from_name($name, $data){
644     global $DB;
646     $field = $DB->get_record('data_fields', array('name'=>$name, 'dataid'=>$data->id));
648     if ($field) {
649         return data_get_field($field, $data);
650     } else {
651         return false;
652     }
655 /**
656  * given a field id
657  * this function creates an instance of the particular subfield class
658  *
659  * @global object
660  * @param int $fieldid
661  * @param object $data
662  * @return bool|object
663  */
664 function data_get_field_from_id($fieldid, $data){
665     global $DB;
667     $field = $DB->get_record('data_fields', array('id'=>$fieldid, 'dataid'=>$data->id));
669     if ($field) {
670         return data_get_field($field, $data);
671     } else {
672         return false;
673     }
676 /**
677  * given a field id
678  * this function creates an instance of the particular subfield class
679  *
680  * @global object
681  * @param string $type
682  * @param object $data
683  * @return object
684  */
685 function data_get_field_new($type, $data) {
686     global $CFG;
688     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
689     $newfield = 'data_field_'.$type;
690     $newfield = new $newfield(0, $data);
691     return $newfield;
694 /**
695  * returns a subclass field object given a record of the field, used to
696  * invoke plugin methods
697  * input: $param $field - record from db
698  *
699  * @global object
700  * @param object $field
701  * @param object $data
702  * @param object $cm
703  * @return object
704  */
705 function data_get_field($field, $data, $cm=null) {
706     global $CFG;
708     if ($field) {
709         require_once('field/'.$field->type.'/field.class.php');
710         $newfield = 'data_field_'.$field->type;
711         $newfield = new $newfield($field, $data, $cm);
712         return $newfield;
713     }
717 /**
718  * Given record object (or id), returns true if the record belongs to the current user
719  *
720  * @global object
721  * @global object
722  * @param mixed $record record object or id
723  * @return bool
724  */
725 function data_isowner($record) {
726     global $USER, $DB;
728     if (!isloggedin()) { // perf shortcut
729         return false;
730     }
732     if (!is_object($record)) {
733         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
734             return false;
735         }
736     }
738     return ($record->userid == $USER->id);
741 /**
742  * has a user reached the max number of entries?
743  *
744  * @param object $data
745  * @return bool
746  */
747 function data_atmaxentries($data){
748     if (!$data->maxentries){
749         return false;
751     } else {
752         return (data_numentries($data) >= $data->maxentries);
753     }
756 /**
757  * returns the number of entries already made by this user
758  *
759  * @global object
760  * @global object
761  * @param object $data
762  * @return int
763  */
764 function data_numentries($data){
765     global $USER, $DB;
766     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
767     return $DB->count_records_sql($sql, array($data->id, $USER->id));
770 /**
771  * function that takes in a dataid and adds a record
772  * this is used everytime an add template is submitted
773  *
774  * @global object
775  * @global object
776  * @param object $data
777  * @param int $groupid
778  * @return bool
779  */
780 function data_add_record($data, $groupid=0){
781     global $USER, $DB;
783     $cm = get_coursemodule_from_instance('data', $data->id);
784     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
786     $record = new object();
787     $record->userid = $USER->id;
788     $record->dataid = $data->id;
789     $record->groupid = $groupid;
790     $record->timecreated = $record->timemodified = time();
791     if (has_capability('mod/data:approve', $context)) {
792         $record->approved = 1;
793     } else {
794         $record->approved = 0;
795     }
796     return $DB->insert_record('data_records', $record);
799 /**
800  * check the multple existence any tag in a template
801  *
802  * check to see if there are 2 or more of the same tag being used.
803  *
804  * @global object
805  * @param int $dataid,
806  * @param string $template
807  * @return bool
808  */
809 function data_tags_check($dataid, $template) {
810     global $DB, $OUTPUT;
812     // first get all the possible tags
813     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
814     // then we generate strings to replace
815     $tagsok = true; // let's be optimistic
816     foreach ($fields as $field){
817         $pattern="/\[\[".$field->name."\]\]/i";
818         if (preg_match_all($pattern, $template, $dummy)>1){
819             $tagsok = false;
820             echo $OUTPUT->notification('[['.$field->name.']] - '.get_string('multipletags','data'));
821         }
822     }
823     // else return true
824     return $tagsok;
827 /**
828  * Adds an instance of a data
829  *
830  * @global object
831  * @param object $data
832  * @return $int
833  */
834 function data_add_instance($data) {
835     global $DB;
837     if (empty($data->assessed)) {
838         $data->assessed = 0;
839     }
841     $data->timemodified = time();
843     $data->id = $DB->insert_record('data', $data);
845     data_grade_item_update($data);
847     return $data->id;
850 /**
851  * updates an instance of a data
852  *
853  * @global object
854  * @param object $data
855  * @return bool
856  */
857 function data_update_instance($data) {
858     global $DB, $OUTPUT;
860     $data->timemodified = time();
861     $data->id           = $data->instance;
863     if (empty($data->assessed)) {
864         $data->assessed = 0;
865     }
867     if (empty($data->ratingtime) or empty($data->assessed)) {
868         $data->assesstimestart  = 0;
869         $data->assesstimefinish = 0;
870     }
872     if (empty($data->notification)) {
873         $data->notification = 0;
874     }
876     $DB->update_record('data', $data);
878     data_grade_item_update($data);
880     return true;
884 /**
885  * deletes an instance of a data
886  *
887  * @global object
888  * @param int $id
889  * @return bool
890  */
891 function data_delete_instance($id) {    // takes the dataid
892     global $DB, $CFG;
894     if (!$data = $DB->get_record('data', array('id'=>$id))) {
895         return false;
896     }
898     $cm = get_coursemodule_from_instance('data', $data->id);
899     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
901 /// Delete all the associated information
903     // files
904     $fs = get_file_storage();
905     $fs->delete_area_files($context->id, 'mod_data');
907     // Delete comments
908     require_once($CFG->dirroot.'/comment/lib.php');
909     comment::delete_comments(array('contextid'=>$context->id));
911     // get all the records in this data
912     $sql = "SELECT r.id
913               FROM {data_records} r
914              WHERE r.dataid = ?";
916     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
918     // delete all the records and fields
919     $DB->delete_records('data_records', array('dataid'=>$id));
920     $DB->delete_records('data_fields', array('dataid'=>$id));
922     // Delete the instance itself
923     $result = $DB->delete_records('data', array('id'=>$id));
925     // cleanup gradebook
926     data_grade_item_delete($data);
928     return $result;
931 /**
932  * returns a summary of data activity of this user
933  *
934  * @global object
935  * @param object $course
936  * @param object $user
937  * @param object $mod
938  * @param object $data
939  * @return object|null
940  */
941 function data_user_outline($course, $user, $mod, $data) {
942     global $DB, $CFG;
943     require_once("$CFG->libdir/gradelib.php");
945     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
946     if (empty($grades->items[0]->grades)) {
947         $grade = false;
948     } else {
949         $grade = reset($grades->items[0]->grades);
950     }
953     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
954         $result = new object();
955         $result->info = get_string('numrecords', 'data', $countrecords);
956         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
957                                               WHERE dataid = ? AND userid = ?
958                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
959         $result->time = $lastrecord->timemodified;
960         if ($grade) {
961             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
962         }
963         return $result;
964     } else if ($grade) {
965         $result = new object();
966         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
967         $result->time = $grade->dategraded;
968         return $result;
969     }
970     return NULL;
973 /**
974  * Prints all the records uploaded by this user
975  *
976  * @global object
977  * @param object $course
978  * @param object $user
979  * @param object $mod
980  * @param object $data
981  */
982 function data_user_complete($course, $user, $mod, $data) {
983     global $DB, $CFG, $OUTPUT;
984     require_once("$CFG->libdir/gradelib.php");
986     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
987     if (!empty($grades->items[0]->grades)) {
988         $grade = reset($grades->items[0]->grades);
989         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
990         if ($grade->str_feedback) {
991             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
992         }
993     }
995     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
996         data_print_template('singletemplate', $records, $data);
997     }
1000 /**
1001  * Return grade for given user or all users.
1002  *
1003  * @global object
1004  * @param object $data
1005  * @param int $userid optional user id, 0 means all users
1006  * @return array array of grades, false if none
1007  */
1008 function data_get_user_grades($data, $userid=0) {
1009     global $CFG;
1011     require_once($CFG->dirroot.'/rating/lib.php');
1012     $rm = new rating_manager();
1014     $ratingoptions = new stdclass();
1015     $ratingoptions->modulename = 'data';
1016     $ratingoptions->moduleid   = $data->id;
1018     $ratingoptions->userid = $userid;
1019     $ratingoptions->aggregationmethod = $data->assessed;
1020     $ratingoptions->scaleid = $data->scale;
1021     $ratingoptions->itemtable = 'data_records';
1022     $ratingoptions->itemtableusercolumn = 'userid';
1024     return $rm->get_user_grades($ratingoptions);
1027 /**
1028  * Update activity grades
1029  *
1030  * @global object
1031  * @global object
1032  * @param object $data
1033  * @param int $userid specific user only, 0 means all
1034  * @param bool $nullifnone
1035  */
1036 function data_update_grades($data, $userid=0, $nullifnone=true) {
1037     global $CFG, $DB;
1038     require_once($CFG->libdir.'/gradelib.php');
1040     if (!$data->assessed) {
1041         data_grade_item_update($data);
1043     } else if ($grades = data_get_user_grades($data, $userid)) {
1044         data_grade_item_update($data, $grades);
1046     } else if ($userid and $nullifnone) {
1047         $grade = new object();
1048         $grade->userid   = $userid;
1049         $grade->rawgrade = NULL;
1050         data_grade_item_update($data, $grade);
1052     } else {
1053         data_grade_item_update($data);
1054     }
1057 /**
1058  * Update all grades in gradebook.
1059  *
1060  * @global object
1061  */
1062 function data_upgrade_grades() {
1063     global $DB;
1065     $sql = "SELECT COUNT('x')
1066               FROM {data} d, {course_modules} cm, {modules} m
1067              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1068     $count = $DB->count_records_sql($sql);
1070     $sql = "SELECT d.*, cm.idnumber AS cmidnumber, d.course AS courseid
1071               FROM {data} d, {course_modules} cm, {modules} m
1072              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1073     if ($rs = $DB->get_recordset_sql($sql)) {
1074         // too much debug output
1075         $pbar = new progress_bar('dataupgradegrades', 500, true);
1076         $i=0;
1077         foreach ($rs as $data) {
1078             $i++;
1079             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
1080             data_update_grades($data, 0, false);
1081             $pbar->update($i, $count, "Updating Database grades ($i/$count).");
1082         }
1083         $rs->close();
1084     }
1087 /**
1088  * Update/create grade item for given data
1089  *
1090  * @global object
1091  * @param object $data object with extra cmidnumber
1092  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
1093  * @return object grade_item
1094  */
1095 function data_grade_item_update($data, $grades=NULL) {
1096     global $CFG;
1097     require_once($CFG->libdir.'/gradelib.php');
1099     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1101     if (!$data->assessed or $data->scale == 0) {
1102         $params['gradetype'] = GRADE_TYPE_NONE;
1104     } else if ($data->scale > 0) {
1105         $params['gradetype'] = GRADE_TYPE_VALUE;
1106         $params['grademax']  = $data->scale;
1107         $params['grademin']  = 0;
1109     } else if ($data->scale < 0) {
1110         $params['gradetype'] = GRADE_TYPE_SCALE;
1111         $params['scaleid']   = -$data->scale;
1112     }
1114     if ($grades  === 'reset') {
1115         $params['reset'] = true;
1116         $grades = NULL;
1117     }
1119     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1122 /**
1123  * Delete grade item for given data
1124  *
1125  * @global object
1126  * @param object $data object
1127  * @return object grade_item
1128  */
1129 function data_grade_item_delete($data) {
1130     global $CFG;
1131     require_once($CFG->libdir.'/gradelib.php');
1133     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1136 /**
1137  * returns a list of participants of this database
1138  *
1139  * @global object
1140  * @return array
1141  */
1142 function data_get_participants($dataid) {
1143 // Returns the users with data in one data
1144 // (users with records in data_records, data_comments and ratings)
1145     global $DB;
1147     $records = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1148                                        FROM {user} u, {data_records} r
1149                                       WHERE r.dataid = ? AND u.id = r.userid", array($dataid));
1151     $comments = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1152                                         FROM {user} u, {data_records} r, {comments} c
1153                                        WHERE r.dataid = ? AND u.id = r.userid AND r.id = c.itemid AND c.commentarea='database_entry'", array($dataid));
1155     $ratings = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1156                                        FROM {user} u, {data_records} r, {ratings} a
1157                                       WHERE r.dataid = ? AND u.id = r.userid AND r.id = a.itemid", array($dataid));
1159     $participants = array();
1161     if ($records) {
1162         foreach ($records as $record) {
1163             $participants[$record->id] = $record;
1164         }
1165     }
1166     if ($comments) {
1167         foreach ($comments as $comment) {
1168             $participants[$comment->id] = $comment;
1169         }
1170     }
1171     if ($ratings) {
1172         foreach ($ratings as $rating) {
1173             $participants[$rating->id] = $rating;
1174         }
1175     }
1177     return $participants;
1180 // junk functions
1181 /**
1182  * takes a list of records, the current data, a search string,
1183  * and mode to display prints the translated template
1184  *
1185  * @global object
1186  * @global object
1187  * @param string $template
1188  * @param array $records
1189  * @param object $data
1190  * @param string $search
1191  * @param int $page
1192  * @param bool $return
1193  * @return mixed
1194  */
1195 function data_print_template($template, $records, $data, $search='', $page=0, $return=false) {
1196     global $CFG, $DB, $OUTPUT;
1197     $cm = get_coursemodule_from_instance('data', $data->id);
1198     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1200     static $fields = NULL;
1201     static $isteacher;
1202     static $dataid = NULL;
1204     if (empty($dataid)) {
1205         $dataid = $data->id;
1206     } else if ($dataid != $data->id) {
1207         $fields = NULL;
1208     }
1210     if (empty($fields)) {
1211         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1212         foreach ($fieldrecords as $fieldrecord) {
1213             $fields[]= data_get_field($fieldrecord, $data);
1214         }
1215         $isteacher = has_capability('mod/data:managetemplates', $context);
1216     }
1218     if (empty($records)) {
1219         return;
1220     }
1222     foreach ($records as $record) {   // Might be just one for the single template
1224     // Replacing tags
1225         $patterns = array();
1226         $replacement = array();
1228     // Then we generate strings to replace for normal tags
1229         foreach ($fields as $field) {
1230             $patterns[]='[['.$field->field->name.']]';
1231             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1232         }
1234     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1235         $patterns[]='##edit##';
1236         $patterns[]='##delete##';
1237         if (has_capability('mod/data:manageentries', $context) or data_isowner($record->id)) {
1238             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1239                              .$data->id.'&amp;rid='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" alt="'.get_string('edit').'" title="'.get_string('edit').'" /></a>';
1240             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1241                              .$data->id.'&amp;delete='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" alt="'.get_string('delete').'" title="'.get_string('delete').'" /></a>';
1242         } else {
1243             $replacement[] = '';
1244             $replacement[] = '';
1245         }
1247         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1248         if ($search) {
1249             $moreurl .= '&amp;filter=1';
1250         }
1251         $patterns[]='##more##';
1252         $replacement[] = '<a href="' . $moreurl . '"><img src="' . $OUTPUT->pix_url('i/search') . '" class="iconsmall" alt="' . get_string('more', 'data') . '" title="' . get_string('more', 'data') . '" /></a>';
1254         $patterns[]='##moreurl##';
1255         $replacement[] = $moreurl;
1257         $patterns[]='##user##';
1258         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1259                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1261         $patterns[]='##export##';
1263         if ($CFG->enableportfolios && ($template == 'singletemplate' || $template == 'listtemplate')
1264             && ((has_capability('mod/data:exportentry', $context)
1265                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1266             require_once($CFG->libdir . '/portfoliolib.php');
1267             $button = new portfolio_add_button();
1268             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), '/mod/data/locallib.php');
1269             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1270             $button->set_formats($formats);
1271             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1272         } else {
1273             $replacement[] = '';
1274         }
1276         $patterns[] = '##timeadded##';
1277         $replacement[] = userdate($record->timecreated);
1279         $patterns[] = '##timemodified##';
1280         $replacement [] = userdate($record->timemodified);
1282         $patterns[]='##approve##';
1283         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)){
1284             $replacement[] = '<span class="approve"><a href="'.$CFG->wwwroot.'/mod/data/view.php?d='.$data->id.'&amp;approve='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('i/approve') . '" class="icon" alt="'.get_string('approve').'" /></a></span>';
1285         } else {
1286             $replacement[] = '';
1287         }
1289         $patterns[]='##comments##';
1290         if (($template == 'listtemplate') && ($data->comments)) {
1292             if (!empty($CFG->usecomments)) {
1293                 require_once($CFG->dirroot  . '/comment/lib.php');
1294                 list($context, $course, $cm) = get_context_info_array($context->id);
1295                 $cmt = new stdclass;
1296                 $cmt->pluginname = 'data';
1297                 $cmt->context = $context;
1298                 $cmt->course  = $course;
1299                 $cmt->cm      = $cm;
1300                 $cmt->area    = 'database_entry';
1301                 $cmt->itemid  = $record->id;
1302                 $cmt->showcount = true;
1303                 $comment = new comment($cmt);
1304                 $replacement[] = $comment->output(true);
1305             }
1306         } else {
1307             $replacement[] = '';
1308         }
1310         // actual replacement of the tags
1311         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1313         // no more html formatting and filtering - see MDL-6635
1314         if ($return) {
1315             return $newtext;
1316         } else {
1317             echo $newtext;
1319             // hack alert - return is always false in singletemplate anyway ;-)
1320             /**********************************
1321              *    Printing Ratings Form       *
1322              *********************************/
1323             if ($template == 'singletemplate') {    //prints ratings options
1324                 data_print_ratings($data, $record);
1325             }
1327             /**********************************
1328              *    Printing Comments Form       *
1329              *********************************/
1330             if (($template == 'singletemplate') && ($data->comments)) {
1331                 if (!empty($CFG->usecomments)) {
1332                     require_once($CFG->dirroot . '/comment/lib.php');
1333                     list($context, $course, $cm) = get_context_info_array($context->id);
1334                     $cmt = new stdclass;
1335                     $cmt->pluginname = 'data';
1336                     $cmt->context = $context;
1337                     $cmt->course  = $course;
1338                     $cmt->cm      = $cm;
1339                     $cmt->area    = 'database_entry';
1340                     $cmt->itemid  = $record->id;
1341                     $cmt->showcount = true;
1342                     $comment = new comment($cmt);
1343                     $comment->output(false);
1344                 }
1345             }
1346         }
1347     }
1350 /**
1351  * Return rating related permissions
1352  * @param string $options the context id
1353  * @return array an associative array of the user's rating permissions
1354  */
1355 function data_rating_permissions($options) {
1356     $contextid = $options;
1357     $context = get_context_instance_by_id($contextid);
1359     if (!$context) {
1360         print_error('invalidcontext');
1361         return null;
1362     } else {
1363         $ret = new stdclass();
1364         return array('view'=>has_capability('mod/data:viewrating',$context), 'viewany'=>has_capability('mod/data:viewanyrating',$context), 'viewall'=>has_capability('mod/data:viewallratings',$context), 'rate'=>has_capability('mod/data:rate',$context));
1365     }
1368 /**
1369  * Returns the names of the table and columns necessary to check items for ratings
1370  * @return array an array containing the item table, item id and user id columns
1371  */
1372 function data_rating_item_check_info() {
1373     return array('data_records','id','userid');
1377 /**
1378  * function that takes in the current data, number of items per page,
1379  * a search string and prints a preference box in view.php
1380  *
1381  * This preference box prints a searchable advanced search template if
1382  *     a) A template is defined
1383  *  b) The advanced search checkbox is checked.
1384  *
1385  * @global object
1386  * @global object
1387  * @param object $data
1388  * @param int $perpage
1389  * @param string $search
1390  * @param string $sort
1391  * @param string $order
1392  * @param array $search_array
1393  * @param int $advanced
1394  * @param string $mode
1395  * @return void
1396  */
1397 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1398     global $CFG, $DB, $PAGE, $OUTPUT;
1400     $cm = get_coursemodule_from_instance('data', $data->id);
1401     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1402     echo '<br /><div class="datapreferences">';
1403     echo '<form id="options" action="view.php" method="get">';
1404     echo '<div>';
1405     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1406     if ($mode =='asearch') {
1407         $advanced = 1;
1408         echo '<input type="hidden" name="mode" value="list" />';
1409     }
1410     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1411     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1412                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1413     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id'=>'pref_perpage'));
1414     echo '<div id="reg_search" style="display: ';
1415     if ($advanced) {
1416         echo 'none';
1417     }
1418     else {
1419         echo 'inline';
1420     }
1421     echo ';" >&nbsp;&nbsp;&nbsp;<label for="pref_search">'.get_string('search').'</label> <input type="text" size="16" name="search" id= "pref_search" value="'.s($search).'" /></div>';
1422     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1423     // foreach field, print the option
1424     echo '<select name="sort" id="pref_sortby">';
1425     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1426         echo '<optgroup label="'.get_string('fields', 'data').'">';
1427         foreach ($fields as $field) {
1428             if ($field->id == $sort) {
1429                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1430             } else {
1431                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1432             }
1433         }
1434         echo '</optgroup>';
1435     }
1436     $options = array();
1437     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1438     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1439     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1440     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1441     if ($data->approval and has_capability('mod/data:approve', $context)) {
1442         $options[DATA_APPROVED] = get_string('approved', 'data');
1443     }
1444     echo '<optgroup label="'.get_string('other', 'data').'">';
1445     foreach ($options as $key => $name) {
1446         if ($key == $sort) {
1447             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1448         } else {
1449             echo '<option value="'.$key.'">'.$name.'</option>';
1450         }
1451     }
1452     echo '</optgroup>';
1453     echo '</select>';
1454     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1455     echo '<select id="pref_order" name="order">';
1456     if ($order == 'ASC') {
1457         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1458     } else {
1459         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1460     }
1461     if ($order == 'DESC') {
1462         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1463     } else {
1464         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1465     }
1466     echo '</select>';
1468     if ($advanced) {
1469         $checked = ' checked="checked" ';
1470     }
1471     else {
1472         $checked = '';
1473     }
1474     $PAGE->requires->js('/mod/data/data.js');
1475     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1476     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1477     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1478     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1480     echo '<br />';
1481     echo '<div class="dataadvancedsearch" id="data_adv_form" style="display: ';
1483     if ($advanced) {
1484         echo 'inline';
1485     }
1486     else {
1487         echo 'none';
1488     }
1489     echo ';margin-left:auto;margin-right:auto;" >';
1490     echo '<table class="boxaligncenter">';
1492     // print ASC or DESC
1493     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1494     $i = 0;
1496     // Determine if we are printing all fields for advanced search, or the template for advanced search
1497     // If a template is not defined, use the deafault template and display all fields.
1498     if(empty($data->asearchtemplate)) {
1499         data_generate_default_template($data, 'asearchtemplate');
1500     }
1502     static $fields = NULL;
1503     static $isteacher;
1504     static $dataid = NULL;
1506     if (empty($dataid)) {
1507         $dataid = $data->id;
1508     } else if ($dataid != $data->id) {
1509         $fields = NULL;
1510     }
1512     if (empty($fields)) {
1513         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1514         foreach ($fieldrecords as $fieldrecord) {
1515             $fields[]= data_get_field($fieldrecord, $data);
1516         }
1518         $isteacher = has_capability('mod/data:managetemplates', $context);
1519     }
1521     // Replacing tags
1522     $patterns = array();
1523     $replacement = array();
1525     // Then we generate strings to replace for normal tags
1526     foreach ($fields as $field) {
1527         $fieldname = $field->field->name;
1528         $fieldname = preg_quote($fieldname, '/');
1529         $patterns[] = "/\[\[$fieldname\]\]/i";
1530         $searchfield = data_get_field_from_id($field->field->id, $data);
1531         if (!empty($search_array[$field->field->id]->data)) {
1532             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1533         } else {
1534             $replacement[] = $searchfield->display_search_field();
1535         }
1536     }
1537     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1538     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1539     $patterns[]    = '/##firstname##/';
1540     $replacement[] = '<input type="text" size="16" name="u_fn" value="'.$fn.'" />';
1541     $patterns[]    = '/##lastname##/';
1542     $replacement[] = '<input type="text" size="16" name="u_ln" value="'.$ln.'" />';
1544     // actual replacement of the tags
1545     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1547     $options = new object();
1548     $options->para=false;
1549     $options->noclean=true;
1550     echo '<tr><td>';
1551     echo format_text($newtext, FORMAT_HTML, $options);
1552     echo '</td></tr>';
1554     echo '<tr><td colspan="4" style="text-align: center;"><br/><input type="submit" value="'.get_string('savesettings','data').'" /><input type="submit" name="resetadv" value="'.get_string('resetsettings','data').'" /></td></tr>';
1555     echo '</table>';
1556     echo '</div>';
1557     echo '</div>';
1558     echo '</form>';
1559     echo '</div>';
1562 /**
1563  * @global object
1564  * @global object
1565  * @param object $data
1566  * @param object $record
1567  * @return void Output echo'd
1568  */
1569 function data_print_ratings($data, $record) {
1570     /*global $USER, $DB, $OUTPUT;
1572     $cm = get_coursemodule_from_instance('data', $data->id);
1573     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1575     if ($data->assessed and isloggedin() and (has_capability('mod/data:rate', $context) or has_capability('mod/data:viewrating', $context) or data_isowner($record->id))) {
1576         if ($ratingsscale = make_grades_menu($data->scale)) {
1577             $ratingsmenuused = false;
1579             echo '<div class="ratings" style="text-align:center">';
1580             echo '<form id="form" method="post" action="rate.php">';
1581             echo '<input type="hidden" name="dataid" value="'.$data->id.'" />';
1583             if (has_capability('mod/data:rate', $context) and !data_isowner($record->id)) {
1584                 data_print_ratings_mean($record->id, $ratingsscale, has_capability('mod/data:viewrating', $context));
1585                 echo '&nbsp;';
1586                 data_print_rating_menu($record->id, $USER->id, $ratingsscale);
1587                 $ratingsmenuused = true;
1589             } else {
1590                 data_print_ratings_mean($record->id, $ratingsscale, true);
1591             }
1593             if ($data->scale < 0) {
1594                 if ($scale = $DB->get_record('scale', array('id'=>abs($data->scale)))) {
1595                     echo $OUTPUT->help_icon_scale($data->course, $scale);
1596                 }
1597             }
1599             if ($ratingsmenuused) {
1600                 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1601                 echo '<input type="submit" value="'.get_string('sendinratings', 'data').'" />';
1602             }
1603             echo '</form>';
1604             echo '</div>';
1605         }
1606     }*/
1607     global $OUTPUT;
1608     if( !empty($record->rating) ){
1609         echo $OUTPUT->render($record->rating);
1610     }
1613 /**
1614  * For Participantion Reports
1615  *
1616  * @return array
1617  */
1618 function data_get_view_actions() {
1619     return array('view');
1622 /**
1623  * @return array
1624  */
1625 function data_get_post_actions() {
1626     return array('add','update','record delete');
1629 /**
1630  * @global object
1631  * @global object
1632  * @param string $name
1633  * @param int $dataid
1634  * @param int $fieldid
1635  * @return bool
1636  */
1637 function data_fieldname_exists($name, $dataid, $fieldid=0) {
1638     global $CFG, $DB;
1640     $LIKE = $DB->sql_ilike();
1641     if ($fieldid) {
1642         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1643                                         WHERE df.name $LIKE ? AND df.dataid = ?
1644                                               AND ((df.id < ?) OR (df.id > ?))", array($name, $dataid, $fieldid, $fieldid));
1645     } else {
1646         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1647                                         WHERE df.name $LIKE ? AND df.dataid = ?", array($name, $dataid));
1648     }
1651 /**
1652  * @param array $fieldinput
1653  */
1654 function data_convert_arrays_to_strings(&$fieldinput) {
1655     foreach ($fieldinput as $key => $val) {
1656         if (is_array($val)) {
1657             $str = '';
1658             foreach ($val as $inner) {
1659                 $str .= $inner . ',';
1660             }
1661             $str = substr($str, 0, -1);
1663             $fieldinput->$key = $str;
1664         }
1665     }
1669 /**
1670  * Converts a database (module instance) to use the Roles System
1671  *
1672  * @global object
1673  * @global object
1674  * @uses CONTEXT_MODULE
1675  * @uses CAP_PREVENT
1676  * @uses CAP_ALLOW
1677  * @param object $data a data object with the same attributes as a record
1678  *                     from the data database table
1679  * @param int $datamodid the id of the data module, from the modules table
1680  * @param array $teacherroles array of roles that have archetype teacher
1681  * @param array $studentroles array of roles that have archetype student
1682  * @param array $guestroles array of roles that have archetype guest
1683  * @param int $cmid the course_module id for this data instance
1684  * @return boolean data module was converted or not
1685  */
1686 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1687     global $CFG, $DB, $OUTPUT;
1689     if (!isset($data->participants) && !isset($data->assesspublic)
1690             && !isset($data->groupmode)) {
1691         // We assume that this database has already been converted to use the
1692         // Roles System. above fields get dropped the data module has been
1693         // upgraded to use Roles.
1694         return false;
1695     }
1697     if (empty($cmid)) {
1698         // We were not given the course_module id. Try to find it.
1699         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1700             echo $OUTPUT->notification('Could not get the course module for the data');
1701             return false;
1702         } else {
1703             $cmid = $cm->id;
1704         }
1705     }
1706     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1709     // $data->participants:
1710     // 1 - Only teachers can add entries
1711     // 3 - Teachers and students can add entries
1712     switch ($data->participants) {
1713         case 1:
1714             foreach ($studentroles as $studentrole) {
1715                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1716             }
1717             foreach ($teacherroles as $teacherrole) {
1718                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1719             }
1720             break;
1721         case 3:
1722             foreach ($studentroles as $studentrole) {
1723                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1724             }
1725             foreach ($teacherroles as $teacherrole) {
1726                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1727             }
1728             break;
1729     }
1731     // $data->assessed:
1732     // 2 - Only teachers can rate posts
1733     // 1 - Everyone can rate posts
1734     // 0 - No one can rate posts
1735     switch ($data->assessed) {
1736         case 0:
1737             foreach ($studentroles as $studentrole) {
1738                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1739             }
1740             foreach ($teacherroles as $teacherrole) {
1741                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1742             }
1743             break;
1744         case 1:
1745             foreach ($studentroles as $studentrole) {
1746                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1747             }
1748             foreach ($teacherroles as $teacherrole) {
1749                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1750             }
1751             break;
1752         case 2:
1753             foreach ($studentroles as $studentrole) {
1754                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1755             }
1756             foreach ($teacherroles as $teacherrole) {
1757                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1758             }
1759             break;
1760     }
1762     // $data->assesspublic:
1763     // 0 - Students can only see their own ratings
1764     // 1 - Students can see everyone's ratings
1765     switch ($data->assesspublic) {
1766         case 0:
1767             foreach ($studentroles as $studentrole) {
1768                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1769             }
1770             foreach ($teacherroles as $teacherrole) {
1771                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1772             }
1773             break;
1774         case 1:
1775             foreach ($studentroles as $studentrole) {
1776                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1777             }
1778             foreach ($teacherroles as $teacherrole) {
1779                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1780             }
1781             break;
1782     }
1784     if (empty($cm)) {
1785         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1786     }
1788     switch ($cm->groupmode) {
1789         case NOGROUPS:
1790             break;
1791         case SEPARATEGROUPS:
1792             foreach ($studentroles as $studentrole) {
1793                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1794             }
1795             foreach ($teacherroles as $teacherrole) {
1796                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1797             }
1798             break;
1799         case VISIBLEGROUPS:
1800             foreach ($studentroles as $studentrole) {
1801                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1802             }
1803             foreach ($teacherroles as $teacherrole) {
1804                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1805             }
1806             break;
1807     }
1808     return true;
1811 /**
1812  * Returns the best name to show for a preset
1813  *
1814  * @param string $shortname
1815  * @param  string $path
1816  * @return string
1817  */
1818 function data_preset_name($shortname, $path) {
1820     // We are looking inside the preset itself as a first choice, but also in normal data directory
1821     $string = get_string('modulename', 'datapreset_'.$shortname);
1823     if (substr($string, 0, 1) == '[') {
1824         return $shortname;
1825     } else {
1826         return $string;
1827     }
1830 /**
1831  * Returns an array of all the available presets
1832  *
1833  * @global object
1834  * @global object
1835  * @return array
1836  */
1837 function data_get_available_presets($context) {
1838     global $CFG, $USER;
1840     $presets = array();
1842     if ($dirs = get_list_of_plugins('mod/data/preset')) {
1843         foreach ($dirs as $dir) {
1844             $fulldir = $CFG->dirroot.'/mod/data/preset/'.$dir;
1846             if (is_directory_a_preset($fulldir)) {
1847                 $preset = new object;
1848                 $preset->path = $fulldir;
1849                 $preset->userid = 0;
1850                 $preset->shortname = $dir;
1851                 $preset->name = data_preset_name($dir, $fulldir);
1852                 if (file_exists($fulldir.'/screenshot.jpg')) {
1853                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1854                 } else if (file_exists($fulldir.'/screenshot.png')) {
1855                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1856                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1857                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1858                 }
1859                 $presets[] = $preset;
1860             }
1861         }
1862     }
1864     if ($userids = get_list_of_plugins('data/preset', '', $CFG->dataroot)) {
1865         foreach ($userids as $userid) {
1866             $fulldir = $CFG->dataroot.'/data/preset/'.$userid;
1868             if ($userid == 0 || $USER->id == $userid || has_capability('mod/data:viewalluserpresets', $context)) {
1870                 if ($dirs = get_list_of_plugins('data/preset/'.$userid, '', $CFG->dataroot)) {
1871                     foreach ($dirs as $dir) {
1872                         $fulldir = $CFG->dataroot.'/data/preset/'.$userid.'/'.$dir;
1874                         if (is_directory_a_preset($fulldir)) {
1875                             $preset = new object;
1876                             $preset->path = $fulldir;
1877                             $preset->userid = $userid;
1878                             $preset->shortname = $dir;
1879                             $preset->name = data_preset_name($dir, $fulldir);
1880                             if (file_exists($fulldir.'/screenshot.jpg')) {
1881                                 $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1882                             } else if (file_exists($fulldir.'/screenshot.png')) {
1883                                 $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1884                             } else if (file_exists($fulldir.'/screenshot.gif')) {
1885                                 $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1886                             }
1887                             $presets[] = $preset;
1888                         }
1889                     }
1890                 }
1891             }
1892         }
1893     }
1895     return $presets;
1898 /**
1899  * @global object
1900  * @global string
1901  * @global string
1902  * @param object $course
1903  * @param object $cm
1904  * @param object $data
1905  * @param string $currenttab
1906  */
1907 function data_print_header($course, $cm, $data, $currenttab='') {
1909     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
1911     $PAGE->set_title($data->name);
1912     echo $OUTPUT->header();
1913     echo $OUTPUT->heading(format_string($data->name));
1915 // Groups needed for Add entry tab
1916     $currentgroup = groups_get_activity_group($cm);
1917     $groupmode = groups_get_activity_groupmode($cm);
1919     // Print the tabs
1921     if ($currenttab) {
1922         include('tabs.php');
1923     }
1925     // Print any notices
1927     if (!empty($displaynoticegood)) {
1928         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
1929     } else if (!empty($displaynoticebad)) {
1930         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
1931     }
1934 /**
1935  * @global object
1936  * @param object $data
1937  * @param mixed $currentgroup
1938  * @param int $groupmode
1939  * @return bool
1940  */
1941 function data_user_can_add_entry($data, $currentgroup, $groupmode) {
1942     global $USER;
1944     if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1945         print_error('invalidcoursemodule');
1946     }
1947     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1949     if (!has_capability('mod/data:writeentry', $context) and !has_capability('mod/data:manageentries',$context)) {
1950         return false;
1951     }
1953     //if in the view only time window
1954     $now = time();
1955     if ($now>$data->timeviewfrom && $now<$data->timeviewto) {
1956         return false;
1957     }
1959     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
1960         return true;
1961     }
1963     if ($currentgroup) {
1964         return groups_is_member($currentgroup);
1965     } else {
1966         //else it might be group 0 in visible mode
1967         if ($groupmode == VISIBLEGROUPS){
1968             return true;
1969         } else {
1970             return false;
1971         }
1972     }
1976 /**
1977  * @return bool
1978  */
1979 function is_directory_a_preset($directory) {
1980     $directory = rtrim($directory, '/\\') . '/';
1981     $status = file_exists($directory.'singletemplate.html') &&
1982               file_exists($directory.'listtemplate.html') &&
1983               file_exists($directory.'listtemplateheader.html') &&
1984               file_exists($directory.'listtemplatefooter.html') &&
1985               file_exists($directory.'addtemplate.html') &&
1986               file_exists($directory.'rsstemplate.html') &&
1987               file_exists($directory.'rsstitletemplate.html') &&
1988               file_exists($directory.'csstemplate.css') &&
1989               file_exists($directory.'jstemplate.js') &&
1990               file_exists($directory.'preset.xml');
1992     return $status;
1995 /**
1996  * @return bool
1997  */
1998 function clean_preset($folder) {
1999     $status = @unlink($folder.'/singletemplate.html') &&
2000               @unlink($folder.'/listtemplate.html') &&
2001               @unlink($folder.'/listtemplateheader.html') &&
2002               @unlink($folder.'/listtemplatefooter.html') &&
2003               @unlink($folder.'/addtemplate.html') &&
2004               @unlink($folder.'/rsstemplate.html') &&
2005               @unlink($folder.'/rsstitletemplate.html') &&
2006               @unlink($folder.'/csstemplate.css') &&
2007               @unlink($folder.'/jstemplate.js') &&
2008               @unlink($folder.'/preset.xml');
2010     // optional
2011     @unlink($folder.'/asearchtemplate.html');
2013     return $status;
2016 /**
2017  * @package   mod-data
2018  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
2019  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2020  */
2021 class PresetImporter {
2022     /**
2023      * @global object
2024      * @param object $course
2025      * @param object $cm
2026      * @param object $data
2027      * @param int $userid
2028      * @param string $shortname
2029      */
2030     function PresetImporter($course, $cm, $data, $userid, $shortname) {
2031         global $CFG;
2032         $this->course = $course;
2033         $this->cm = $cm;
2034         $this->data = $data;
2035         $this->userid = $userid;
2036         $this->shortname = $shortname;
2037         $this->folder = data_preset_path($course, $userid, $shortname);
2038     }
2039     /**
2040      * @global object
2041      * @global object
2042      * @return array
2043      */
2044     function get_settings() {
2045         global $CFG, $DB;
2047         if (!is_directory_a_preset($this->folder)) {
2048             print_error('invalidpreset', 'data', '', $this->userid.'/'.$this->shortname);
2049         }
2051         /* Grab XML */
2052         $presetxml = file_get_contents($this->folder.'/preset.xml');
2053         $parsedxml = xmlize($presetxml, 0);
2055         $allowed_settings = array('intro', 'comments', 'requiredentries', 'requiredentriestoview',
2056                                   'maxentries', 'rssarticles', 'approval', 'defaultsortdir', 'defaultsort');
2058         /* First, do settings. Put in user friendly array. */
2059         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2060         $settings = new StdClass();
2062         foreach ($settingsarray as $setting => $value) {
2063             if (!is_array($value)) {
2064                 continue;
2065             }
2066             if (!in_array($setting, $allowed_settings)) {
2067                 // unsupported setting
2068                 continue;
2069             }
2070             $settings->$setting = $value[0]['#'];
2071         }
2073         /* Now work out fields to user friendly array */
2074         $fieldsarray = $parsedxml['preset']['#']['field'];
2075         $fields = array();
2076         foreach ($fieldsarray as $field) {
2077             if (!is_array($field)) {
2078                 continue;
2079             }
2080             $f = new StdClass();
2081             foreach ($field['#'] as $param => $value) {
2082                 if (!is_array($value)) {
2083                     continue;
2084                 }
2085                 $f->$param = $value[0]['#'];
2086             }
2087             $f->dataid = $this->data->id;
2088             $f->type = clean_param($f->type, PARAM_ALPHA);
2089             $fields[] = $f;
2090         }
2091         /* Now add the HTML templates to the settings array so we can update d */
2092         $settings->singletemplate     = file_get_contents($this->folder."/singletemplate.html");
2093         $settings->listtemplate       = file_get_contents($this->folder."/listtemplate.html");
2094         $settings->listtemplateheader = file_get_contents($this->folder."/listtemplateheader.html");
2095         $settings->listtemplatefooter = file_get_contents($this->folder."/listtemplatefooter.html");
2096         $settings->addtemplate        = file_get_contents($this->folder."/addtemplate.html");
2097         $settings->rsstemplate        = file_get_contents($this->folder."/rsstemplate.html");
2098         $settings->rsstitletemplate   = file_get_contents($this->folder."/rsstitletemplate.html");
2099         $settings->csstemplate        = file_get_contents($this->folder."/csstemplate.css");
2100         $settings->jstemplate         = file_get_contents($this->folder."/jstemplate.js");
2102         //optional
2103         if (file_exists($this->folder."/asearchtemplate.html")) {
2104             $settings->asearchtemplate = file_get_contents($this->folder."/asearchtemplate.html");
2105         } else {
2106             $settings->asearchtemplate = NULL;
2107         }
2109         $settings->instance = $this->data->id;
2111         /* Now we look at the current structure (if any) to work out whether we need to clear db
2112            or save the data */
2113         if (!$currentfields = $DB->get_records('data_fields', array('dataid'=>$this->data->id))) {
2114             $currentfields = array();
2115         }
2117         return array($settings, $fields, $currentfields);
2118     }
2120     /**
2121      *
2122      */
2123     function import_options() {
2124         global $OUTPUT;
2125         if (!confirm_sesskey()) {
2126             print_error('invalidsesskey');
2127         }
2129         $strblank = get_string('blank', 'data');
2130         $strcontinue = get_string('continue');
2131         $strwarning = get_string('mappingwarning', 'data');
2132         $strfieldmappings = get_string('fieldmappings', 'data');
2133         $strnew = get_string('new');
2135         $sesskey = sesskey();
2137         list($settings, $newfields,  $currentfields) = $this->get_settings();
2139         echo '<div class="presetmapping"><form action="preset.php" method="post">';
2140         echo '<div>';
2141         echo '<input type="hidden" name="action" value="finishimport" />';
2142         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
2143         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />';
2144         echo '<input type="hidden" name="fullname" value="'.$this->userid.'/'.$this->shortname.'" />';
2146         if (!empty($currentfields) && !empty($newfields)) {
2147             echo "<h3>$strfieldmappings ";
2148             echo $OUTPUT->help_icon('fieldmappings', 'data');
2149             echo '</h3><table>';
2151             foreach ($newfields as $nid => $newfield) {
2152                 echo "<tr><td><label for=\"id_$newfield->name\">$newfield->name</label></td>";
2153                 echo '<td><select name="field_'.$nid.'" id="id_'.$newfield->name.'">';
2155                 $selected = false;
2156                 foreach ($currentfields as $cid => $currentfield) {
2157                     if ($currentfield->type == $newfield->type) {
2158                         if ($currentfield->name == $newfield->name) {
2159                             echo '<option value="'.$cid.'" selected="selected">'.$currentfield->name.'</option>';
2160                             $selected=true;
2161                         }
2162                         else {
2163                             echo '<option value="'.$cid.'">'.$currentfield->name.'</option>';
2164                         }
2165                     }
2166                 }
2168                 if ($selected)
2169                     echo '<option value="-1">-</option>';
2170                 else
2171                     echo '<option value="-1" selected="selected">-</option>';
2172                 echo '</select></td></tr>';
2173             }
2174             echo '</table>';
2175             echo "<p>$strwarning</p>";
2177         } else if (empty($newfields)) {
2178             print_error('nodefinedfields', 'data');
2179         }
2181         echo '<div class="overwritesettings"><label for="overwritesettings">'.get_string('overwritesettings', 'data');
2182         echo '<input id="overwritesettings" name="overwritesettings" type="checkbox" /></label></div>';
2184         echo '<input class="button" type="submit" value="'.$strcontinue.'" /></div></form></div>';
2186     }
2188     /**
2189      * @global object
2190      * @global object
2191      * @return bool
2192      */
2193     function import() {
2194         global $CFG, $DB;
2196         list($settings, $newfields, $currentfields) = $this->get_settings();
2197         $preservedfields = array();
2199         $overwritesettings = optional_param('overwritesettings', 0, PARAM_BOOL);
2201         /* Maps fields and makes new ones */
2202         if (!empty($newfields)) {
2203             /* We require an injective mapping, and need to know what to protect */
2204             foreach ($newfields as $nid => $newfield) {
2205                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2206                 if ($cid == -1) continue;
2208                 if (array_key_exists($cid, $preservedfields)){
2209                     print_error('notinjectivemap', 'data');
2210                 }
2211                 else $preservedfields[$cid] = true;
2212             }
2214             foreach ($newfields as $nid => $newfield) {
2215                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2217                 /* A mapping. Just need to change field params. Data kept. */
2218                 if ($cid != -1 and isset($currentfields[$cid])) {
2219                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->data);
2220                     foreach ($newfield as $param => $value) {
2221                         if ($param != "id") {
2222                             $fieldobject->field->$param = $value;
2223                         }
2224                     }
2225                     unset($fieldobject->field->similarfield);
2226                     $fieldobject->update_field();
2227                     unset($fieldobject);
2228                 }
2229                 /* Make a new field */
2230                 else {
2231                     include_once("field/$newfield->type/field.class.php");
2233                     if (!isset($newfield->description)) {
2234                         $newfield->description = '';
2235                     }
2236                     $classname = 'data_field_'.$newfield->type;
2237                     $fieldclass = new $classname($newfield, $this->data);
2238                     $fieldclass->insert_field();
2239                     unset($fieldclass);
2240                 }
2241             }
2242         }
2244         /* Get rid of all old unused data */
2245         if (!empty($preservedfields)) {
2246             foreach ($currentfields as $cid => $currentfield) {
2247                 if (!array_key_exists($cid, $preservedfields)) {
2248                     /* Data not used anymore so wipe! */
2249                     print "Deleting field $currentfield->name<br />";
2251                     $id = $currentfield->id;
2252                     //Why delete existing data records and related comments/ratings??
2253 /*
2254                     if ($content = $DB->get_records('data_content', array('fieldid'=>$id))) {
2255                         foreach ($content as $item) {
2256                             $DB->delete_records('data_ratings', array('recordid'=>$item->recordid));
2257                             $DB->delete_records('data_comments', array('recordid'=>$item->recordid));
2258                             $DB->delete_records('data_records', array('id'=>$item->recordid));
2259                         }
2260                     }*/
2261                     $DB->delete_records('data_content', array('fieldid'=>$id));
2262                     $DB->delete_records('data_fields', array('id'=>$id));
2263                 }
2264             }
2265         }
2267     // handle special settings here
2268         if (!empty($settings->defaultsort)) {
2269             if (is_numeric($settings->defaultsort)) {
2270                 // old broken value
2271                 $settings->defaultsort = 0;
2272             } else {
2273                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->data->id, 'name'=>$settings->defaultsort));
2274             }
2275         } else {
2276             $settings->defaultsort = 0;
2277         }
2279         // do we want to overwrite all current database settings?
2280         if ($overwritesettings) {
2281             // all supported settings
2282             $overwrite = array_keys((array)$settings);
2283         } else {
2284             // only templates and sorting
2285             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2286                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2287                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2288         }
2290         // now overwrite current data settings
2291         foreach ($this->data as $prop=>$unused) {
2292             if (in_array($prop, $overwrite)) {
2293                 $this->data->$prop = $settings->$prop;
2294             }
2295         }
2297         data_update_instance($this->data);
2299         if (strstr($this->folder, '/temp/')) {
2300         // Removes the temporary files
2301             clean_preset($this->folder);
2302         }
2304         return true;
2305     }
2308 /**
2309  * @global object
2310  * @global object
2311  * @param object $course
2312  * @param int $userid
2313  * @param string $shortname
2314  * @return string
2315  */
2316 function data_preset_path($course, $userid, $shortname) {
2317     global $USER, $CFG;
2319     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2321     $userid = (int)$userid;
2323     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2324         return $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2325     } else if ($userid == 0) {
2326         return $CFG->dirroot.'/mod/data/preset/'.$shortname;
2327     } else if ($userid < 0) {
2328         return $CFG->dataroot.'/temp/data/'.-$userid.'/'.$shortname;
2329     }
2331     return 'Does it disturb you that this code will never run?';
2334 /**
2335  * Implementation of the function for printing the form elements that control
2336  * whether the course reset functionality affects the data.
2337  *
2338  * @param $mform form passed by reference
2339  */
2340 function data_reset_course_form_definition(&$mform) {
2341     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2342     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2344     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2345     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2347     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2348     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2350     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2351     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2354 /**
2355  * Course reset form defaults.
2356  * @return array
2357  */
2358 function data_reset_course_form_defaults($course) {
2359     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2362 /**
2363  * Removes all grades from gradebook
2364  *
2365  * @global object
2366  * @global object
2367  * @param int $courseid
2368  * @param string $type optional type
2369  */
2370 function data_reset_gradebook($courseid, $type='') {
2371     global $CFG, $DB;
2373     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2374               FROM {data} d, {course_modules} cm, {modules} m
2375              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2377     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2378         foreach ($datas as $data) {
2379             data_grade_item_update($data, 'reset');
2380         }
2381     }
2384 /**
2385  * Actual implementation of the rest coures functionality, delete all the
2386  * data responses for course $data->courseid.
2387  *
2388  * @global object
2389  * @global object
2390  * @param object $data the data submitted from the reset course.
2391  * @return array status array
2392  */
2393 function data_reset_userdata($data) {
2394     global $CFG, $DB;
2395     require_once($CFG->libdir.'/filelib.php');
2396     require_once($CFG->dirroot.'/rating/lib.php');
2398     $componentstr = get_string('modulenameplural', 'data');
2399     $status = array();
2401     $allrecordssql = "SELECT r.id
2402                         FROM {data_records} r
2403                              INNER JOIN {data} d ON r.dataid = d.id
2404                        WHERE d.course = ?";
2406     $alldatassql = "SELECT d.id
2407                       FROM {data} d
2408                      WHERE d.course=?";
2410     $rm = new rating_manager();
2411     $ratingdeloptions = new stdclass();
2413     // delete entries if requested
2414     if (!empty($data->reset_data)) {
2415         //$DB->delete_records_select('data_ratings', "recordid IN ($allrecordssql)", array($data->courseid));
2416         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2417         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2418         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2420         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2421             foreach ($datas as $dataid=>$unused) {
2422                 fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$dataid");
2424                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2425                     continue;
2426                 }
2427                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2429                 $ratingdeloptions->contextid = $datacontext->id;
2430                 $rm->delete_ratings($ratingdeloptions);
2431             }
2432         }
2434         if (empty($data->reset_gradebook_grades)) {
2435             // remove all grades from gradebook
2436             data_reset_gradebook($data->courseid);
2437         }
2438         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2439     }
2441     // remove entries by users not enrolled into course
2442     if (!empty($data->reset_data_notenrolled)) {
2443         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2444                          FROM {data_records} r
2445                               JOIN {data} d ON r.dataid = d.id
2446                               LEFT JOIN {user} u ON r.userid = u.id
2447                         WHERE d.course = ? AND r.userid > 0";
2449         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2450         $notenrolled = array();
2451         $fields = array();
2452         if ($rs = $DB->get_recordset_sql($recordssql, array($data->courseid))) {
2453             foreach ($rs as $record) {
2454                 if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2455                   or !is_enrolled($course_context, $record->userid)) {
2456                     //delete ratings
2457                     //$DB->delete_records('data_ratings', array('recordid'=>$record->id));
2458                     if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2459                         continue;
2460                     }
2461                     $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2462                     $ratingdeloptions->contextid = $datacontext->id;
2463                     $ratingdeloptions->itemid = $record->id;
2464                     $rm->delete_ratings($ratingdeloptions);
2466                     $DB->delete_records('comments', array('itemid'=>$record->id, 'commentarea'=>'database_entry'));
2467                     $DB->delete_records('data_content', array('recordid'=>$record->id));
2468                     $DB->delete_records('data_records', array('id'=>$record->id));
2469                     // HACK: this is ugly - the recordid should be before the fieldid!
2470                     if (!array_key_exists($record->dataid, $fields)) {
2471                         if ($fs = $DB->get_records('data_fields', array('dataid'=>$record->dataid))) {
2472                             $fields[$record->dataid] = array_keys($fs);
2473                         } else {
2474                             $fields[$record->dataid] = array();
2475                         }
2476                     }
2477                     foreach($fields[$record->dataid] as $fieldid) {
2478                         fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$record->dataid/$fieldid/$record->id");
2479                     }
2480                     $notenrolled[$record->userid] = true;
2481                 }
2482             }
2483             $rs->close();
2484             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2485         }
2486     }
2488     // remove all ratings
2489     if (!empty($data->reset_data_ratings)) {
2490         //$DB->delete_records_select('data_ratings', "recordid IN ($allrecordssql)", array($data->courseid));
2491         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2492             foreach ($datas as $dataid=>$unused) {
2493                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2494                     continue;
2495                 }
2496                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2498                 $ratingdeloptions->contextid = $datacontext->id;
2499                 $rm->delete_ratings($ratingdeloptions);
2500             }
2501         }
2503         if (empty($data->reset_gradebook_grades)) {
2504             // remove all grades from gradebook
2505             data_reset_gradebook($data->courseid);
2506         }
2508         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2509     }
2511     // remove all comments
2512     if (!empty($data->reset_data_comments)) {
2513         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2514         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2515     }
2517     // updating dates - shift may be negative too
2518     if ($data->timeshift) {
2519         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2520         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2521     }
2523     return $status;
2526 /**
2527  * Returns all other caps used in module
2528  *
2529  * @return array
2530  */
2531 function data_get_extra_capabilities() {
2532     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate', 'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete');
2535 /**
2536  * @param string $feature FEATURE_xx constant for requested feature
2537  * @return mixed True if module supports feature, null if doesn't know
2538  */
2539 function data_supports($feature) {
2540     switch($feature) {
2541         case FEATURE_GROUPS:                  return true;
2542         case FEATURE_GROUPINGS:               return true;
2543         case FEATURE_GROUPMEMBERSONLY:        return true;
2544         case FEATURE_MOD_INTRO:               return true;
2545         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2546         case FEATURE_GRADE_HAS_GRADE:         return true;
2547         case FEATURE_GRADE_OUTCOMES:          return true;
2548         case FEATURE_RATE:                    return true;
2550         default: return null;
2551     }
2553 /**
2554  * @global object
2555  * @param array $export
2556  * @param string $delimiter_name
2557  * @param object $database
2558  * @param int $count
2559  * @param bool $return
2560  * @return string|void
2561  */
2562 function data_export_csv($export, $delimiter_name, $dataname, $count, $return=false) {
2563     global $CFG;
2564     require_once($CFG->libdir . '/csvlib.class.php');
2565     $delimiter = csv_import_reader::get_delimiter($delimiter_name);
2566     $filename = clean_filename("${dataname}-${count}_record");
2567     if ($count > 1) {
2568         $filename .= 's';
2569     }
2570     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2571     $filename .= clean_filename("-${delimiter_name}_separated");
2572     $filename .= '.csv';
2573     if (empty($return)) {
2574         header("Content-Type: application/download\n");
2575         header("Content-Disposition: attachment; filename=$filename");
2576         header('Expires: 0');
2577         header('Cache-Control: must-revalidate,post-check=0,pre-check=0');
2578         header('Pragma: public');
2579     }
2580     $encdelim = '&#' . ord($delimiter) . ';';
2581     $returnstr = '';
2582     foreach($export as $row) {
2583         foreach($row as $key => $column) {
2584             $row[$key] = str_replace($delimiter, $encdelim, $column);
2585         }
2586         $returnstr .= implode($delimiter, $row) . "\n";
2587     }
2588     if (empty($return)) {
2589         echo $returnstr;
2590         return;
2591     }
2592     return $returnstr;
2595 /**
2596  * @global object
2597  * @param array $export
2598  * @param string $dataname
2599  * @param int $count
2600  * @return string
2601  */
2602 function data_export_xls($export, $dataname, $count) {
2603     global $CFG;
2604     require_once("$CFG->libdir/excellib.class.php");
2605     $filename = clean_filename("${dataname}-${count}_record");
2606     if ($count > 1) {
2607         $filename .= 's';
2608     }
2609     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2610     $filename .= '.xls';
2612     $filearg = '-';
2613     $workbook = new MoodleExcelWorkbook($filearg);
2614     $workbook->send($filename);
2615     $worksheet = array();
2616     $worksheet[0] =& $workbook->add_worksheet('');
2617     $rowno = 0;
2618     foreach ($export as $row) {
2619         $colno = 0;
2620         foreach($row as $col) {
2621             $worksheet[0]->write($rowno, $colno, $col);
2622             $colno++;
2623         }
2624         $rowno++;
2625     }
2626     $workbook->close();
2627     return $filename;
2630 /**
2631  * @global object
2632  * @param array $export
2633  * @param string $dataname
2634  * @param int $count
2635  * @param string
2636  */
2637 function data_export_ods($export, $dataname, $count) {
2638     global $CFG;
2639     require_once("$CFG->libdir/odslib.class.php");
2640     $filename = clean_filename("${dataname}-${count}_record");
2641     if ($count > 1) {
2642         $filename .= 's';
2643     }
2644     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2645     $filename .= '.ods';
2646     $filearg = '-';
2647     $workbook = new MoodleODSWorkbook($filearg);
2648     $workbook->send($filename);
2649     $worksheet = array();
2650     $worksheet[0] =& $workbook->add_worksheet('');
2651     $rowno = 0;
2652     foreach ($export as $row) {
2653         $colno = 0;
2654         foreach($row as $col) {
2655             $worksheet[0]->write($rowno, $colno, $col);
2656             $colno++;
2657         }
2658         $rowno++;
2659     }
2660     $workbook->close();
2661     return $filename;
2664 /**
2665  * @global object
2666  * @param int $dataid
2667  * @param array $fields
2668  * @param array $selectedfields
2669  * @return array
2670  */
2671 function data_get_exportdata($dataid, $fields, $selectedfields) {
2672     global $DB;
2674     $exportdata = array();
2676     // populate the header in first row of export
2677     foreach($fields as $key => $field) {
2678         if (!in_array($field->field->id, $selectedfields)) {
2679             // ignore values we aren't exporting
2680             unset($fields[$key]);
2681         } else {
2682             $exportdata[0][] = $field->field->name;
2683         }
2684     }
2686     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2687     ksort($datarecords);
2688     $line = 1;
2689     foreach($datarecords as $record) {
2690         // get content indexed by fieldid
2691         if( $content = $DB->get_records('data_content', array('recordid'=>$record->id), 'fieldid', 'fieldid, content, content1, content2, content3, content4') ) {
2692             foreach($fields as $field) {
2693                 $contents = '';
2694                 if(isset($content[$field->field->id])) {
2695                     $contents = $field->export_text_value($content[$field->field->id]);
2696                 }
2697                 $exportdata[$line][] = $contents;
2698             }
2699         }
2700         $line++;
2701     }
2702     $line--;
2703     return $exportdata;
2706 /**
2707  * Lists all browsable file areas
2708  *
2709  * @param object $course
2710  * @param object $cm
2711  * @param object $context
2712  * @return array
2713  */
2714 function data_get_file_areas($course, $cm, $context) {
2715     $areas = array();
2716     return $areas;
2719 /**
2720  * Serves the data attachments. Implements needed access control ;-)
2721  *
2722  * @param object $course
2723  * @param object $cm
2724  * @param object $context
2725  * @param string $filearea
2726  * @param array $args
2727  * @param bool $forcedownload
2728  * @return bool false if file not found, does not return if found - justsend the file
2729  */
2730 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
2731     global $CFG, $DB;
2733     if ($context->contextlevel != CONTEXT_MODULE) {
2734         return false;
2735     }
2737     require_login($course, false, $cm);
2739     if ($filearea === 'content') {
2740         $contentid = (int)array_shift($args);
2742         if (!$cm = get_coursemodule_from_instance('data', $cm->instance, $course->id)) {
2743             return false;
2744         }
2746         require_course_login($course, true, $cm);
2748         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
2749             return false;
2750         }
2752         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2753             return false;
2754         }
2756         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2757             return false;
2758         }
2760         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2761             return false;
2762         }
2764         //check if approved
2765         if (!$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2766             return false;
2767         }
2769         // group access
2770         if ($record->groupid) {
2771             $groupmode = groups_get_activity_groupmode($cm, $course);
2772             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2773                 if (!groups_is_member($record->groupid)) {
2774                     return false;
2775                 }
2776             }
2777         }
2779         $fieldobj = data_get_field($field, $data, $cm);
2781         $relativepath = implode('/', $args);
2782         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
2784         if (!$fieldobj->file_ok($relativepath)) {
2785             return false;
2786         }
2788         $fs = get_file_storage();
2789         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2790             return false;
2791         }
2793         // finally send the file
2794         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
2795     }
2797     return false;
2801 function data_extend_navigation($navigation, $course, $module, $cm) {
2802     global $CFG, $OUTPUT, $USER, $DB;
2804     $rid = optional_param('rid', 0, PARAM_INT);
2806     $data = $DB->get_record('data', array('id'=>$cm->instance));
2807     $currentgroup = groups_get_activity_group($cm);
2808     $groupmode = groups_get_activity_groupmode($cm);
2810      $numentries = data_numentries($data);
2811     /// Check the number of entries required against the number of entries already made (doesn't apply to teachers)
2812     if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !has_capability('mod/data:manageentries', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2813         $data->entriesleft = $data->requiredentries - $numentries;
2814         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
2815         $entriesnode->add_class('note');
2816     }
2818     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
2819     if (!empty($rid)) {
2820         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
2821     } else {
2822         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
2823     }
2824     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'search')));
2827 /**
2828  * Adds module specific settings to the settings block
2829  *
2830  * @param settings_navigation $settings The settings navigation object
2831  * @param navigation_node $datanode The node to add module settings to
2832  */
2833 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
2834     global $PAGE, $DB, $CFG, $USER;
2836     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
2838     $currentgroup = groups_get_activity_group($PAGE->cm);
2839     $groupmode = groups_get_activity_groupmode($PAGE->cm);
2841     if (data_user_can_add_entry($data, $currentgroup, $groupmode)) { // took out participation list here!
2842         if (empty($editentry)) {
2843             $addstring = get_string('add', 'data');
2844         } else {
2845             $addstring = get_string('editentry', 'data');
2846         }
2847         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
2848     }
2850     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
2851         // The capability required to Export database records is centrally defined in 'lib.php'
2852         // and should be weaker than those required to edit Templates, Fields and Presets.
2853         $datanode->add(get_string('export', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
2854     }
2855     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
2856         $datanode->add(get_string('import'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
2857     }
2859     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
2860         $currenttab = '';
2861         if ($currenttab == 'list') {
2862             $defaultemplate = 'listtemplate';
2863         } else if ($currenttab == 'add') {
2864             $defaultemplate = 'addtemplate';
2865         } else if ($currenttab == 'asearch') {
2866             $defaultemplate = 'asearchtemplate';
2867         } else {
2868             $defaultemplate = 'singletemplate';
2869         }
2871         $templates = $datanode->add(get_string('templates', 'data'));
2873         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
2874         foreach ($templatelist as $template) {
2875             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
2876         }
2878         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
2879         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
2880     }
2882     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
2883         require_once("$CFG->libdir/rsslib.php");
2885         $string = get_string('rsstype','forum');
2887         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
2888         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2889     }