2616e20f1105e4180e144658c1a5b5076797051e
[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');
36 define('DATA_PRESET_COMPONENT', 'mod_data');
37 define('DATA_PRESET_FILEAREA', 'site_presets');
38 define('DATA_PRESET_CONTEXT', SYSCONTEXTID);
40 // Users having assigned the default role "Non-editing teacher" can export database records
41 // Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
42 // In Moodle >= 2, new roles may be introduced and used instead.
44 /**
45  * @package   mod-data
46  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
47  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  */
49 class data_field_base {     // Base class for Database Field Types (see field/*/field.class.php)
51     /** @var string Subclasses must override the type with their name */
52     var $type = 'unknown';
53     /** @var object The database object that this field belongs to */
54     var $data = NULL;
55     /** @var object The field object itself, if we know it */
56     var $field = NULL;
57     /** @var int Width of the icon for this fieldtype */
58     var $iconwidth = 16;
59     /** @var int Width of the icon for this fieldtype */
60     var $iconheight = 16;
61     /** @var object course module or cmifno */
62     var $cm;
63     /** @var object activity context */
64     var $context;
66     /**
67      * Constructor function
68      *
69      * @global object
70      * @uses CONTEXT_MODULE
71      * @param int $field
72      * @param int $data
73      * @param int $cm
74      */
75     function __construct($field=0, $data=0, $cm=0) {   // Field or data or both, each can be id or object
76         global $DB;
78         if (empty($field) && empty($data)) {
79             print_error('missingfield', 'data');
80         }
82         if (!empty($field)) {
83             if (is_object($field)) {
84                 $this->field = $field;  // Programmer knows what they are doing, we hope
85             } else if (!$this->field = $DB->get_record('data_fields', array('id'=>$field))) {
86                 print_error('invalidfieldid', 'data');
87             }
88             if (empty($data)) {
89                 if (!$this->data = $DB->get_record('data', array('id'=>$this->field->dataid))) {
90                     print_error('invalidid', 'data');
91                 }
92             }
93         }
95         if (empty($this->data)) {         // We need to define this properly
96             if (!empty($data)) {
97                 if (is_object($data)) {
98                     $this->data = $data;  // Programmer knows what they are doing, we hope
99                 } else if (!$this->data = $DB->get_record('data', array('id'=>$data))) {
100                     print_error('invalidid', 'data');
101                 }
102             } else {                      // No way to define it!
103                 print_error('missingdata', 'data');
104             }
105         }
107         if ($cm) {
108             $this->cm = $cm;
109         } else {
110             $this->cm = get_coursemodule_from_instance('data', $this->data->id);
111         }
113         if (empty($this->field)) {         // We need to define some default values
114             $this->define_default_field();
115         }
117         $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
118     }
121     /**
122      * This field just sets up a default field object
123      *
124      * @return bool
125      */
126     function define_default_field() {
127         global $OUTPUT;
128         if (empty($this->data->id)) {
129             echo $OUTPUT->notification('Programmer error: dataid not defined in field class');
130         }
131         $this->field = new object;
132         $this->field->id = 0;
133         $this->field->dataid = $this->data->id;
134         $this->field->type   = $this->type;
135         $this->field->param1 = '';
136         $this->field->param2 = '';
137         $this->field->param3 = '';
138         $this->field->name = '';
139         $this->field->description = '';
141         return true;
142     }
144     /**
145      * Set up the field object according to data in an object.  Now is the time to clean it!
146      *
147      * @return bool
148      */
149     function define_field($data) {
150         $this->field->type        = $this->type;
151         $this->field->dataid      = $this->data->id;
153         $this->field->name        = trim($data->name);
154         $this->field->description = trim($data->description);
156         if (isset($data->param1)) {
157             $this->field->param1 = trim($data->param1);
158         }
159         if (isset($data->param2)) {
160             $this->field->param2 = trim($data->param2);
161         }
162         if (isset($data->param3)) {
163             $this->field->param3 = trim($data->param3);
164         }
165         if (isset($data->param4)) {
166             $this->field->param4 = trim($data->param4);
167         }
168         if (isset($data->param5)) {
169             $this->field->param5 = trim($data->param5);
170         }
172         return true;
173     }
175     /**
176      * Insert a new field in the database
177      * We assume the field object is already defined as $this->field
178      *
179      * @global object
180      * @return bool
181      */
182     function insert_field() {
183         global $DB, $OUTPUT;
185         if (empty($this->field)) {
186             echo $OUTPUT->notification('Programmer error: Field has not been defined yet!  See define_field()');
187             return false;
188         }
190         $this->field->id = $DB->insert_record('data_fields',$this->field);
191         return true;
192     }
195     /**
196      * Update a field in the database
197      *
198      * @global object
199      * @return bool
200      */
201     function update_field() {
202         global $DB;
204         $DB->update_record('data_fields', $this->field);
205         return true;
206     }
208     /**
209      * Delete a field completely
210      *
211      * @global object
212      * @return bool
213      */
214     function delete_field() {
215         global $DB;
217         if (!empty($this->field->id)) {
218             $this->delete_content();
219             $DB->delete_records('data_fields', array('id'=>$this->field->id));
220         }
221         return true;
222     }
224     /**
225      * Print the relevant form element in the ADD template for this field
226      *
227      * @global object
228      * @param int $recordid
229      * @return string
230      */
231     function display_add_field($recordid=0){
232         global $DB;
234         if ($recordid){
235             $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
236         } else {
237             $content = '';
238         }
240         // beware get_field returns false for new, empty records MDL-18567
241         if ($content===false) {
242             $content='';
243         }
245         $str = '<div title="'.s($this->field->description).'">';
246         $str .= '<input style="width:300px;" type="text" name="field_'.$this->field->id.'" id="field_'.$this->field->id.'" value="'.s($content).'" />';
247         $str .= '</div>';
249         return $str;
250     }
252     /**
253      * Print the relevant form element to define the attributes for this field
254      * viewable by teachers only.
255      *
256      * @global object
257      * @global object
258      * @return void Output is echo'd
259      */
260     function display_edit_field() {
261         global $CFG, $DB, $OUTPUT;
263         if (empty($this->field)) {   // No field has been defined yet, try and make one
264             $this->define_default_field();
265         }
266         echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
268         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
269         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
270         if (empty($this->field->id)) {
271             echo '<input type="hidden" name="mode" value="add" />'."\n";
272             $savebutton = get_string('add');
273         } else {
274             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
275             echo '<input type="hidden" name="mode" value="update" />'."\n";
276             $savebutton = get_string('savechanges');
277         }
278         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
279         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
281         echo $OUTPUT->heading($this->name());
283         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
285         echo '<div class="mdl-align">';
286         echo '<input type="submit" value="'.$savebutton.'" />'."\n";
287         echo '<input type="submit" name="cancel" value="'.get_string('cancel').'" />'."\n";
288         echo '</div>';
290         echo '</form>';
292         echo $OUTPUT->box_end();
293     }
295     /**
296      * Display the content of the field in browse mode
297      *
298      * @global object
299      * @param int $recordid
300      * @param object $template
301      * @return bool|string
302      */
303     function display_browse_field($recordid, $template) {
304         global $DB;
306         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
307             if (isset($content->content)) {
308                 $options = new object();
309                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
310                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
311                     //$content->content1 = FORMAT_HTML;
312                     $options->filter=false;
313                 }
314                 $options->para = false;
315                 $str = format_text($content->content, $content->content1, $options);
316             } else {
317                 $str = '';
318             }
319             return $str;
320         }
321         return false;
322     }
324     /**
325      * Update the content of one data field in the data_content table
326      * @global object
327      * @param int $recordid
328      * @param mixed $value
329      * @param string $name
330      * @return bool
331      */
332     function update_content($recordid, $value, $name=''){
333         global $DB;
335         $content = new object();
336         $content->fieldid = $this->field->id;
337         $content->recordid = $recordid;
338         $content->content = clean_param($value, PARAM_NOTAGS);
340         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
341             $content->id = $oldcontent->id;
342             return $DB->update_record('data_content', $content);
343         } else {
344             return $DB->insert_record('data_content', $content);
345         }
346     }
348     /**
349      * Delete all content associated with the field
350      *
351      * @global object
352      * @param int $recordid
353      * @return bool
354      */
355     function delete_content($recordid=0) {
356         global $DB;
358         if ($recordid) {
359             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
360         } else {
361             $conditions = array('fieldid'=>$this->field->id);
362         }
364         if ($rs = $DB->get_recordset('data_content', $conditions)) {
365             $fs = get_file_storage();
366             foreach ($rs as $content) {
367                 $fs->delete_area_files($this->context->id, 'mod_data', 'content', $content->id);
368             }
369             $rs->close();
370         }
372         return $DB->delete_records('data_content', $conditions);
373     }
375     /**
376      * Check if a field from an add form is empty
377      *
378      * @param mixed $value
379      * @param mixed $name
380      * @return bool
381      */
382     function notemptyfield($value, $name) {
383         return !empty($value);
384     }
386     /**
387      * Just in case a field needs to print something before the whole form
388      */
389     function print_before_form() {
390     }
392     /**
393      * Just in case a field needs to print something after the whole form
394      */
395     function print_after_form() {
396     }
399     /**
400      * Returns the sortable field for the content. By default, it's just content
401      * but for some plugins, it could be content 1 - content4
402      *
403      * @return string
404      */
405     function get_sort_field() {
406         return 'content';
407     }
409     /**
410      * Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
411      *
412      * @param string $fieldname
413      * @return string $fieldname
414      */
415     function get_sort_sql($fieldname) {
416         return $fieldname;
417     }
419     /**
420      * Returns the name/type of the field
421      *
422      * @return string
423      */
424     function name() {
425         return get_string('name'.$this->type, 'data');
426     }
428     /**
429      * Prints the respective type icon
430      *
431      * @global object
432      * @return string
433      */
434     function image() {
435         global $OUTPUT;
437         $params = array('d'=>$this->data->id, 'fid'=>$this->field->id, 'mode'=>'display', 'sesskey'=>sesskey());
438         $link = new moodle_url('/mod/data/field.php', $params);
439         $str = '<a href="'.$link->out().'">';
440         $str .= '<img src="'.$OUTPUT->pix_url('field/'.$this->type, 'data') . '" ';
441         $str .= 'height="'.$this->iconheight.'" width="'.$this->iconwidth.'" alt="'.$this->type.'" title="'.$this->type.'" /></a>';
442         return $str;
443     }
445     /**
446      * Per default, it is assumed that fields support text exporting.
447      * Override this (return false) on fields not supporting text exporting.
448      *
449      * @return bool true
450      */
451     function text_export_supported() {
452         return true;
453     }
455     /**
456      * Per default, return the record's text value only from the "content" field.
457      * Override this in fields class if necesarry.
458      *
459      * @param string $record
460      * @return string
461      */
462     function export_text_value($record) {
463         if ($this->text_export_supported()) {
464             return $record->content;
465         }
466     }
468     /**
469      * @param string $relativepath
470      * @return bool false
471      */
472     function file_ok($relativepath) {
473         return false;
474     }
478 /**
479  * Given a template and a dataid, generate a default case template
480  *
481  * @global object
482  * @param object $data
483  * @param string template [addtemplate, singletemplate, listtempalte, rsstemplate]
484  * @param int $recordid
485  * @param bool $form
486  * @param bool $update
487  * @return bool|string
488  */
489 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
490     global $DB;
492     if (!$data && !$template) {
493         return false;
494     }
495     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
496         return '';
497     }
499     // get all the fields for that database
500     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
502         $str = '<div class="defaulttemplate">';
503         $str .= '<table cellpadding="5">';
505         foreach ($fields as $field) {
507             $str .= '<tr><td valign="top" align="right">';
508             // Yu: commenting this out, the id was wrong and will fix later
509             //if ($template == 'addtemplate') {
510                 //$str .= '<label';
511                 //if (!in_array($field->type, array('picture', 'checkbox', 'date', 'latlong', 'radiobutton'))) {
512                 //    $str .= ' for="[['.$field->name.'#id]]"';
513                 //}
514                 //$str .= '>'.$field->name.'</label>';
516             //} else {
517                 $str .= $field->name.': ';
518             //}
519             $str .= '</td>';
521             $str .='<td  align="left">';
522             if ($form) {   // Print forms instead of data
523                 $fieldobj = data_get_field($field, $data);
524                 $str .= $fieldobj->display_add_field($recordid);
526             } else {           // Just print the tag
527                 $str .= '[['.$field->name.']]';
528             }
529             $str .= '</td></tr>';
531         }
532         if ($template == 'listtemplate') {
533             $str .= '<tr><td align="center" colspan="2">##edit##  ##more##  ##delete##  ##approve##  ##export##</td></tr>';
534         } else if ($template == 'singletemplate') {
535             $str .= '<tr><td align="center" colspan="2">##edit##  ##delete##  ##approve##  ##export##</td></tr>';
536         } else if ($template == 'asearchtemplate') {
537             $str .= '<tr><td valign="top" align="right">'.get_string('authorfirstname', 'data').': </td><td>##firstname##</td></tr>';
538             $str .= '<tr><td valign="top" align="right">'.get_string('authorlastname', 'data').': </td><td>##lastname##</td></tr>';
539         }
541         $str .= '</table>';
542         $str .= '</div>';
544         if ($template == 'listtemplate'){
545             $str .= '<hr />';
546         }
548         if ($update) {
549             $newdata = new object();
550             $newdata->id = $data->id;
551             $newdata->{$template} = $str;
552             $DB->update_record('data', $newdata);
553             $data->{$template} = $str;
554         }
556         return $str;
557     }
561 /**
562  * Search for a field name and replaces it with another one in all the
563  * form templates. Set $newfieldname as '' if you want to delete the
564  * field from the form.
565  *
566  * @global object
567  * @param object $data
568  * @param string $searchfieldname
569  * @param string $newfieldname
570  * @return bool
571  */
572 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
573     global $DB;
575     if (!empty($newfieldname)) {
576         $prestring = '[[';
577         $poststring = ']]';
578         $idpart = '#id';
580     } else {
581         $prestring = '';
582         $poststring = '';
583         $idpart = '';
584     }
586     $newdata = new object();
587     $newdata->id = $data->id;
588     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
589             $prestring.$newfieldname.$poststring, $data->singletemplate);
591     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
592             $prestring.$newfieldname.$poststring, $data->listtemplate);
594     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
595             $prestring.$newfieldname.$poststring, $data->addtemplate);
597     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
598             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
600     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
601             $prestring.$newfieldname.$poststring, $data->rsstemplate);
603     return $DB->update_record('data', $newdata);
607 /**
608  * Appends a new field at the end of the form template.
609  *
610  * @global object
611  * @param object $data
612  * @param string $newfieldname
613  */
614 function data_append_new_field_to_templates($data, $newfieldname) {
615     global $DB;
617     $newdata = new object();
618     $newdata->id = $data->id;
619     $change = false;
621     if (!empty($data->singletemplate)) {
622         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
623         $change = true;
624     }
625     if (!empty($data->addtemplate)) {
626         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
627         $change = true;
628     }
629     if (!empty($data->rsstemplate)) {
630         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
631         $change = true;
632     }
633     if ($change) {
634         $DB->update_record('data', $newdata);
635     }
639 /**
640  * given a field name
641  * this function creates an instance of the particular subfield class
642  *
643  * @global object
644  * @param string $name
645  * @param object $data
646  * @return object|bool
647  */
648 function data_get_field_from_name($name, $data){
649     global $DB;
651     $field = $DB->get_record('data_fields', array('name'=>$name, 'dataid'=>$data->id));
653     if ($field) {
654         return data_get_field($field, $data);
655     } else {
656         return false;
657     }
660 /**
661  * given a field id
662  * this function creates an instance of the particular subfield class
663  *
664  * @global object
665  * @param int $fieldid
666  * @param object $data
667  * @return bool|object
668  */
669 function data_get_field_from_id($fieldid, $data){
670     global $DB;
672     $field = $DB->get_record('data_fields', array('id'=>$fieldid, 'dataid'=>$data->id));
674     if ($field) {
675         return data_get_field($field, $data);
676     } else {
677         return false;
678     }
681 /**
682  * given a field id
683  * this function creates an instance of the particular subfield class
684  *
685  * @global object
686  * @param string $type
687  * @param object $data
688  * @return object
689  */
690 function data_get_field_new($type, $data) {
691     global $CFG;
693     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
694     $newfield = 'data_field_'.$type;
695     $newfield = new $newfield(0, $data);
696     return $newfield;
699 /**
700  * returns a subclass field object given a record of the field, used to
701  * invoke plugin methods
702  * input: $param $field - record from db
703  *
704  * @global object
705  * @param object $field
706  * @param object $data
707  * @param object $cm
708  * @return object
709  */
710 function data_get_field($field, $data, $cm=null) {
711     global $CFG;
713     if ($field) {
714         require_once('field/'.$field->type.'/field.class.php');
715         $newfield = 'data_field_'.$field->type;
716         $newfield = new $newfield($field, $data, $cm);
717         return $newfield;
718     }
722 /**
723  * Given record object (or id), returns true if the record belongs to the current user
724  *
725  * @global object
726  * @global object
727  * @param mixed $record record object or id
728  * @return bool
729  */
730 function data_isowner($record) {
731     global $USER, $DB;
733     if (!isloggedin()) { // perf shortcut
734         return false;
735     }
737     if (!is_object($record)) {
738         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
739             return false;
740         }
741     }
743     return ($record->userid == $USER->id);
746 /**
747  * has a user reached the max number of entries?
748  *
749  * @param object $data
750  * @return bool
751  */
752 function data_atmaxentries($data){
753     if (!$data->maxentries){
754         return false;
756     } else {
757         return (data_numentries($data) >= $data->maxentries);
758     }
761 /**
762  * returns the number of entries already made by this user
763  *
764  * @global object
765  * @global object
766  * @param object $data
767  * @return int
768  */
769 function data_numentries($data){
770     global $USER, $DB;
771     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
772     return $DB->count_records_sql($sql, array($data->id, $USER->id));
775 /**
776  * function that takes in a dataid and adds a record
777  * this is used everytime an add template is submitted
778  *
779  * @global object
780  * @global object
781  * @param object $data
782  * @param int $groupid
783  * @return bool
784  */
785 function data_add_record($data, $groupid=0){
786     global $USER, $DB;
788     $cm = get_coursemodule_from_instance('data', $data->id);
789     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
791     $record = new object();
792     $record->userid = $USER->id;
793     $record->dataid = $data->id;
794     $record->groupid = $groupid;
795     $record->timecreated = $record->timemodified = time();
796     if (has_capability('mod/data:approve', $context)) {
797         $record->approved = 1;
798     } else {
799         $record->approved = 0;
800     }
801     return $DB->insert_record('data_records', $record);
804 /**
805  * check the multple existence any tag in a template
806  *
807  * check to see if there are 2 or more of the same tag being used.
808  *
809  * @global object
810  * @param int $dataid,
811  * @param string $template
812  * @return bool
813  */
814 function data_tags_check($dataid, $template) {
815     global $DB, $OUTPUT;
817     // first get all the possible tags
818     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
819     // then we generate strings to replace
820     $tagsok = true; // let's be optimistic
821     foreach ($fields as $field){
822         $pattern="/\[\[".$field->name."\]\]/i";
823         if (preg_match_all($pattern, $template, $dummy)>1){
824             $tagsok = false;
825             echo $OUTPUT->notification('[['.$field->name.']] - '.get_string('multipletags','data'));
826         }
827     }
828     // else return true
829     return $tagsok;
832 /**
833  * Adds an instance of a data
834  *
835  * @global object
836  * @param object $data
837  * @return $int
838  */
839 function data_add_instance($data) {
840     global $DB;
842     if (empty($data->assessed)) {
843         $data->assessed = 0;
844     }
846     $data->timemodified = time();
848     $data->id = $DB->insert_record('data', $data);
850     data_grade_item_update($data);
852     return $data->id;
855 /**
856  * updates an instance of a data
857  *
858  * @global object
859  * @param object $data
860  * @return bool
861  */
862 function data_update_instance($data) {
863     global $DB, $OUTPUT;
865     $data->timemodified = time();
866     $data->id           = $data->instance;
868     if (empty($data->assessed)) {
869         $data->assessed = 0;
870     }
872     if (empty($data->ratingtime) or empty($data->assessed)) {
873         $data->assesstimestart  = 0;
874         $data->assesstimefinish = 0;
875     }
877     if (empty($data->notification)) {
878         $data->notification = 0;
879     }
881     $DB->update_record('data', $data);
883     data_grade_item_update($data);
885     return true;
889 /**
890  * deletes an instance of a data
891  *
892  * @global object
893  * @param int $id
894  * @return bool
895  */
896 function data_delete_instance($id) {    // takes the dataid
897     global $DB, $CFG;
899     if (!$data = $DB->get_record('data', array('id'=>$id))) {
900         return false;
901     }
903     $cm = get_coursemodule_from_instance('data', $data->id);
904     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
906 /// Delete all the associated information
908     // files
909     $fs = get_file_storage();
910     $fs->delete_area_files($context->id, 'mod_data');
912     // Delete comments
913     require_once($CFG->dirroot.'/comment/lib.php');
914     comment::delete_comments(array('contextid'=>$context->id));
916     // Delete ratings
917     //delete ratings
918     require_once($CFG->dirroot.'/rating/lib.php');
919     $delopt = new stdclass();
920     $delopt->contextid = $context->id;
921     $rm = new rating_manager();
922     $rm->delete_ratings($delopt);
924     // get all the records in this data
925     $sql = "SELECT r.id
926               FROM {data_records} r
927              WHERE r.dataid = ?";
929     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
931     // delete all the records and fields
932     $DB->delete_records('data_records', array('dataid'=>$id));
933     $DB->delete_records('data_fields', array('dataid'=>$id));
935     // Delete the instance itself
936     $result = $DB->delete_records('data', array('id'=>$id));
938     // cleanup gradebook
939     data_grade_item_delete($data);
941     return $result;
944 /**
945  * returns a summary of data activity of this user
946  *
947  * @global object
948  * @param object $course
949  * @param object $user
950  * @param object $mod
951  * @param object $data
952  * @return object|null
953  */
954 function data_user_outline($course, $user, $mod, $data) {
955     global $DB, $CFG;
956     require_once("$CFG->libdir/gradelib.php");
958     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
959     if (empty($grades->items[0]->grades)) {
960         $grade = false;
961     } else {
962         $grade = reset($grades->items[0]->grades);
963     }
966     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
967         $result = new object();
968         $result->info = get_string('numrecords', 'data', $countrecords);
969         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
970                                               WHERE dataid = ? AND userid = ?
971                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
972         $result->time = $lastrecord->timemodified;
973         if ($grade) {
974             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
975         }
976         return $result;
977     } else if ($grade) {
978         $result = new object();
979         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
980         $result->time = $grade->dategraded;
981         return $result;
982     }
983     return NULL;
986 /**
987  * Prints all the records uploaded by this user
988  *
989  * @global object
990  * @param object $course
991  * @param object $user
992  * @param object $mod
993  * @param object $data
994  */
995 function data_user_complete($course, $user, $mod, $data) {
996     global $DB, $CFG, $OUTPUT;
997     require_once("$CFG->libdir/gradelib.php");
999     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1000     if (!empty($grades->items[0]->grades)) {
1001         $grade = reset($grades->items[0]->grades);
1002         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1003         if ($grade->str_feedback) {
1004             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1005         }
1006     }
1008     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1009         data_print_template('singletemplate', $records, $data);
1010     }
1013 /**
1014  * Return grade for given user or all users.
1015  *
1016  * @global object
1017  * @param object $data
1018  * @param int $userid optional user id, 0 means all users
1019  * @return array array of grades, false if none
1020  */
1021 function data_get_user_grades($data, $userid=0) {
1022     global $CFG;
1024     require_once($CFG->dirroot.'/rating/lib.php');
1025     $rm = new rating_manager();
1027     $ratingoptions = new stdclass();
1028     $ratingoptions->modulename = 'data';
1029     $ratingoptions->moduleid   = $data->id;
1031     $ratingoptions->userid = $userid;
1032     $ratingoptions->aggregationmethod = $data->assessed;
1033     $ratingoptions->scaleid = $data->scale;
1034     $ratingoptions->itemtable = 'data_records';
1035     $ratingoptions->itemtableusercolumn = 'userid';
1037     return $rm->get_user_grades($ratingoptions);
1040 /**
1041  * Update activity grades
1042  *
1043  * @global object
1044  * @global object
1045  * @param object $data
1046  * @param int $userid specific user only, 0 means all
1047  * @param bool $nullifnone
1048  */
1049 function data_update_grades($data, $userid=0, $nullifnone=true) {
1050     global $CFG, $DB;
1051     require_once($CFG->libdir.'/gradelib.php');
1053     if (!$data->assessed) {
1054         data_grade_item_update($data);
1056     } else if ($grades = data_get_user_grades($data, $userid)) {
1057         data_grade_item_update($data, $grades);
1059     } else if ($userid and $nullifnone) {
1060         $grade = new object();
1061         $grade->userid   = $userid;
1062         $grade->rawgrade = NULL;
1063         data_grade_item_update($data, $grade);
1065     } else {
1066         data_grade_item_update($data);
1067     }
1070 /**
1071  * Update all grades in gradebook.
1072  *
1073  * @global object
1074  */
1075 function data_upgrade_grades() {
1076     global $DB;
1078     $sql = "SELECT COUNT('x')
1079               FROM {data} d, {course_modules} cm, {modules} m
1080              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1081     $count = $DB->count_records_sql($sql);
1083     $sql = "SELECT d.*, cm.idnumber AS cmidnumber, d.course AS courseid
1084               FROM {data} d, {course_modules} cm, {modules} m
1085              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1086     if ($rs = $DB->get_recordset_sql($sql)) {
1087         // too much debug output
1088         $pbar = new progress_bar('dataupgradegrades', 500, true);
1089         $i=0;
1090         foreach ($rs as $data) {
1091             $i++;
1092             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
1093             data_update_grades($data, 0, false);
1094             $pbar->update($i, $count, "Updating Database grades ($i/$count).");
1095         }
1096         $rs->close();
1097     }
1100 /**
1101  * Update/create grade item for given data
1102  *
1103  * @global object
1104  * @param object $data object with extra cmidnumber
1105  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
1106  * @return object grade_item
1107  */
1108 function data_grade_item_update($data, $grades=NULL) {
1109     global $CFG;
1110     require_once($CFG->libdir.'/gradelib.php');
1112     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1114     if (!$data->assessed or $data->scale == 0) {
1115         $params['gradetype'] = GRADE_TYPE_NONE;
1117     } else if ($data->scale > 0) {
1118         $params['gradetype'] = GRADE_TYPE_VALUE;
1119         $params['grademax']  = $data->scale;
1120         $params['grademin']  = 0;
1122     } else if ($data->scale < 0) {
1123         $params['gradetype'] = GRADE_TYPE_SCALE;
1124         $params['scaleid']   = -$data->scale;
1125     }
1127     if ($grades  === 'reset') {
1128         $params['reset'] = true;
1129         $grades = NULL;
1130     }
1132     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1135 /**
1136  * Delete grade item for given data
1137  *
1138  * @global object
1139  * @param object $data object
1140  * @return object grade_item
1141  */
1142 function data_grade_item_delete($data) {
1143     global $CFG;
1144     require_once($CFG->libdir.'/gradelib.php');
1146     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1149 /**
1150  * returns a list of participants of this database
1151  *
1152  * @global object
1153  * @return array
1154  */
1155 function data_get_participants($dataid) {
1156 // Returns the users with data in one data
1157 // (users with records in data_records, data_comments and ratings)
1158     global $DB;
1160     $records = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1161                                        FROM {user} u, {data_records} r
1162                                       WHERE r.dataid = ? AND u.id = r.userid", array($dataid));
1164     $comments = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1165                                         FROM {user} u, {data_records} r, {comments} c
1166                                        WHERE r.dataid = ? AND u.id = r.userid AND r.id = c.itemid AND c.commentarea='database_entry'", array($dataid));
1168     $ratings = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1169                                        FROM {user} u, {data_records} r, {ratings} a
1170                                       WHERE r.dataid = ? AND u.id = r.userid AND r.id = a.itemid", array($dataid));
1172     $participants = array();
1174     if ($records) {
1175         foreach ($records as $record) {
1176             $participants[$record->id] = $record;
1177         }
1178     }
1179     if ($comments) {
1180         foreach ($comments as $comment) {
1181             $participants[$comment->id] = $comment;
1182         }
1183     }
1184     if ($ratings) {
1185         foreach ($ratings as $rating) {
1186             $participants[$rating->id] = $rating;
1187         }
1188     }
1190     return $participants;
1193 // junk functions
1194 /**
1195  * takes a list of records, the current data, a search string,
1196  * and mode to display prints the translated template
1197  *
1198  * @global object
1199  * @global object
1200  * @param string $template
1201  * @param array $records
1202  * @param object $data
1203  * @param string $search
1204  * @param int $page
1205  * @param bool $return
1206  * @return mixed
1207  */
1208 function data_print_template($template, $records, $data, $search='', $page=0, $return=false) {
1209     global $CFG, $DB, $OUTPUT;
1210     $cm = get_coursemodule_from_instance('data', $data->id);
1211     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1213     static $fields = NULL;
1214     static $isteacher;
1215     static $dataid = NULL;
1217     if (empty($dataid)) {
1218         $dataid = $data->id;
1219     } else if ($dataid != $data->id) {
1220         $fields = NULL;
1221     }
1223     if (empty($fields)) {
1224         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1225         foreach ($fieldrecords as $fieldrecord) {
1226             $fields[]= data_get_field($fieldrecord, $data);
1227         }
1228         $isteacher = has_capability('mod/data:managetemplates', $context);
1229     }
1231     if (empty($records)) {
1232         return;
1233     }
1235     foreach ($records as $record) {   // Might be just one for the single template
1237     // Replacing tags
1238         $patterns = array();
1239         $replacement = array();
1241     // Then we generate strings to replace for normal tags
1242         foreach ($fields as $field) {
1243             $patterns[]='[['.$field->field->name.']]';
1244             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1245         }
1247     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1248         $patterns[]='##edit##';
1249         $patterns[]='##delete##';
1250         if (has_capability('mod/data:manageentries', $context) or data_isowner($record->id)) {
1251             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1252                              .$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>';
1253             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1254                              .$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>';
1255         } else {
1256             $replacement[] = '';
1257             $replacement[] = '';
1258         }
1260         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1261         if ($search) {
1262             $moreurl .= '&amp;filter=1';
1263         }
1264         $patterns[]='##more##';
1265         $replacement[] = '<a href="' . $moreurl . '"><img src="' . $OUTPUT->pix_url('i/search') . '" class="iconsmall" alt="' . get_string('more', 'data') . '" title="' . get_string('more', 'data') . '" /></a>';
1267         $patterns[]='##moreurl##';
1268         $replacement[] = $moreurl;
1270         $patterns[]='##user##';
1271         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1272                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1274         $patterns[]='##export##';
1276         if ($CFG->enableportfolios && ($template == 'singletemplate' || $template == 'listtemplate')
1277             && ((has_capability('mod/data:exportentry', $context)
1278                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1279             require_once($CFG->libdir . '/portfoliolib.php');
1280             $button = new portfolio_add_button();
1281             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), '/mod/data/locallib.php');
1282             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1283             $button->set_formats($formats);
1284             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1285         } else {
1286             $replacement[] = '';
1287         }
1289         $patterns[] = '##timeadded##';
1290         $replacement[] = userdate($record->timecreated);
1292         $patterns[] = '##timemodified##';
1293         $replacement [] = userdate($record->timemodified);
1295         $patterns[]='##approve##';
1296         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)){
1297             $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>';
1298         } else {
1299             $replacement[] = '';
1300         }
1302         $patterns[]='##comments##';
1303         if (($template == 'listtemplate') && ($data->comments)) {
1305             if (!empty($CFG->usecomments)) {
1306                 require_once($CFG->dirroot  . '/comment/lib.php');
1307                 list($context, $course, $cm) = get_context_info_array($context->id);
1308                 $cmt = new stdclass;
1309                 $cmt->pluginname = 'data';
1310                 $cmt->context = $context;
1311                 $cmt->course  = $course;
1312                 $cmt->cm      = $cm;
1313                 $cmt->area    = 'database_entry';
1314                 $cmt->itemid  = $record->id;
1315                 $cmt->showcount = true;
1316                 $comment = new comment($cmt);
1317                 $replacement[] = $comment->output(true);
1318             }
1319         } else {
1320             $replacement[] = '';
1321         }
1323         // actual replacement of the tags
1324         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1326         // no more html formatting and filtering - see MDL-6635
1327         if ($return) {
1328             return $newtext;
1329         } else {
1330             echo $newtext;
1332             // hack alert - return is always false in singletemplate anyway ;-)
1333             /**********************************
1334              *    Printing Ratings Form       *
1335              *********************************/
1336             if ($template == 'singletemplate') {    //prints ratings options
1337                 data_print_ratings($data, $record);
1338             }
1340             /**********************************
1341              *    Printing Comments Form       *
1342              *********************************/
1343             if (($template == 'singletemplate') && ($data->comments)) {
1344                 if (!empty($CFG->usecomments)) {
1345                     require_once($CFG->dirroot . '/comment/lib.php');
1346                     list($context, $course, $cm) = get_context_info_array($context->id);
1347                     $cmt = new stdclass;
1348                     $cmt->pluginname = 'data';
1349                     $cmt->context = $context;
1350                     $cmt->course  = $course;
1351                     $cmt->cm      = $cm;
1352                     $cmt->area    = 'database_entry';
1353                     $cmt->itemid  = $record->id;
1354                     $cmt->showcount = true;
1355                     $comment = new comment($cmt);
1356                     $comment->output(false);
1357                 }
1358             }
1359         }
1360     }
1363 /**
1364  * Return rating related permissions
1365  * @param string $options the context id
1366  * @return array an associative array of the user's rating permissions
1367  */
1368 function data_rating_permissions($options) {
1369     $contextid = $options;
1370     $context = get_context_instance_by_id($contextid);
1372     if (!$context) {
1373         print_error('invalidcontext');
1374         return null;
1375     } else {
1376         $ret = new stdclass();
1377         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));
1378     }
1381 /**
1382  * Returns the names of the table and columns necessary to check items for ratings
1383  * @return array an array containing the item table, item id and user id columns
1384  */
1385 function data_rating_item_check_info() {
1386     return array('data_records','id','userid');
1390 /**
1391  * function that takes in the current data, number of items per page,
1392  * a search string and prints a preference box in view.php
1393  *
1394  * This preference box prints a searchable advanced search template if
1395  *     a) A template is defined
1396  *  b) The advanced search checkbox is checked.
1397  *
1398  * @global object
1399  * @global object
1400  * @param object $data
1401  * @param int $perpage
1402  * @param string $search
1403  * @param string $sort
1404  * @param string $order
1405  * @param array $search_array
1406  * @param int $advanced
1407  * @param string $mode
1408  * @return void
1409  */
1410 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1411     global $CFG, $DB, $PAGE, $OUTPUT;
1413     $cm = get_coursemodule_from_instance('data', $data->id);
1414     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1415     echo '<br /><div class="datapreferences">';
1416     echo '<form id="options" action="view.php" method="get">';
1417     echo '<div>';
1418     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1419     if ($mode =='asearch') {
1420         $advanced = 1;
1421         echo '<input type="hidden" name="mode" value="list" />';
1422     }
1423     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1424     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1425                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1426     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id'=>'pref_perpage'));
1427     echo '<div id="reg_search" style="display: ';
1428     if ($advanced) {
1429         echo 'none';
1430     }
1431     else {
1432         echo 'inline';
1433     }
1434     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>';
1435     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1436     // foreach field, print the option
1437     echo '<select name="sort" id="pref_sortby">';
1438     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1439         echo '<optgroup label="'.get_string('fields', 'data').'">';
1440         foreach ($fields as $field) {
1441             if ($field->id == $sort) {
1442                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1443             } else {
1444                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1445             }
1446         }
1447         echo '</optgroup>';
1448     }
1449     $options = array();
1450     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1451     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1452     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1453     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1454     if ($data->approval and has_capability('mod/data:approve', $context)) {
1455         $options[DATA_APPROVED] = get_string('approved', 'data');
1456     }
1457     echo '<optgroup label="'.get_string('other', 'data').'">';
1458     foreach ($options as $key => $name) {
1459         if ($key == $sort) {
1460             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1461         } else {
1462             echo '<option value="'.$key.'">'.$name.'</option>';
1463         }
1464     }
1465     echo '</optgroup>';
1466     echo '</select>';
1467     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1468     echo '<select id="pref_order" name="order">';
1469     if ($order == 'ASC') {
1470         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1471     } else {
1472         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1473     }
1474     if ($order == 'DESC') {
1475         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1476     } else {
1477         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1478     }
1479     echo '</select>';
1481     if ($advanced) {
1482         $checked = ' checked="checked" ';
1483     }
1484     else {
1485         $checked = '';
1486     }
1487     $PAGE->requires->js('/mod/data/data.js');
1488     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1489     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1490     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1491     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1493     echo '<br />';
1494     echo '<div class="dataadvancedsearch" id="data_adv_form" style="display: ';
1496     if ($advanced) {
1497         echo 'inline';
1498     }
1499     else {
1500         echo 'none';
1501     }
1502     echo ';margin-left:auto;margin-right:auto;" >';
1503     echo '<table class="boxaligncenter">';
1505     // print ASC or DESC
1506     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1507     $i = 0;
1509     // Determine if we are printing all fields for advanced search, or the template for advanced search
1510     // If a template is not defined, use the deafault template and display all fields.
1511     if(empty($data->asearchtemplate)) {
1512         data_generate_default_template($data, 'asearchtemplate');
1513     }
1515     static $fields = NULL;
1516     static $isteacher;
1517     static $dataid = NULL;
1519     if (empty($dataid)) {
1520         $dataid = $data->id;
1521     } else if ($dataid != $data->id) {
1522         $fields = NULL;
1523     }
1525     if (empty($fields)) {
1526         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1527         foreach ($fieldrecords as $fieldrecord) {
1528             $fields[]= data_get_field($fieldrecord, $data);
1529         }
1531         $isteacher = has_capability('mod/data:managetemplates', $context);
1532     }
1534     // Replacing tags
1535     $patterns = array();
1536     $replacement = array();
1538     // Then we generate strings to replace for normal tags
1539     foreach ($fields as $field) {
1540         $fieldname = $field->field->name;
1541         $fieldname = preg_quote($fieldname, '/');
1542         $patterns[] = "/\[\[$fieldname\]\]/i";
1543         $searchfield = data_get_field_from_id($field->field->id, $data);
1544         if (!empty($search_array[$field->field->id]->data)) {
1545             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1546         } else {
1547             $replacement[] = $searchfield->display_search_field();
1548         }
1549     }
1550     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1551     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1552     $patterns[]    = '/##firstname##/';
1553     $replacement[] = '<input type="text" size="16" name="u_fn" value="'.$fn.'" />';
1554     $patterns[]    = '/##lastname##/';
1555     $replacement[] = '<input type="text" size="16" name="u_ln" value="'.$ln.'" />';
1557     // actual replacement of the tags
1558     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1560     $options = new object();
1561     $options->para=false;
1562     $options->noclean=true;
1563     echo '<tr><td>';
1564     echo format_text($newtext, FORMAT_HTML, $options);
1565     echo '</td></tr>';
1567     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>';
1568     echo '</table>';
1569     echo '</div>';
1570     echo '</div>';
1571     echo '</form>';
1572     echo '</div>';
1575 /**
1576  * @global object
1577  * @global object
1578  * @param object $data
1579  * @param object $record
1580  * @return void Output echo'd
1581  */
1582 function data_print_ratings($data, $record) {
1583     /*global $USER, $DB, $OUTPUT;
1585     $cm = get_coursemodule_from_instance('data', $data->id);
1586     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1588     if ($data->assessed and isloggedin() and (has_capability('mod/data:rate', $context) or has_capability('mod/data:viewrating', $context) or data_isowner($record->id))) {
1589         if ($ratingsscale = make_grades_menu($data->scale)) {
1590             $ratingsmenuused = false;
1592             echo '<div class="ratings" style="text-align:center">';
1593             echo '<form id="form" method="post" action="rate.php">';
1594             echo '<input type="hidden" name="dataid" value="'.$data->id.'" />';
1596             if (has_capability('mod/data:rate', $context) and !data_isowner($record->id)) {
1597                 data_print_ratings_mean($record->id, $ratingsscale, has_capability('mod/data:viewrating', $context));
1598                 echo '&nbsp;';
1599                 data_print_rating_menu($record->id, $USER->id, $ratingsscale);
1600                 $ratingsmenuused = true;
1602             } else {
1603                 data_print_ratings_mean($record->id, $ratingsscale, true);
1604             }
1606             if ($data->scale < 0) {
1607                 if ($scale = $DB->get_record('scale', array('id'=>abs($data->scale)))) {
1608                     echo $OUTPUT->help_icon_scale($data->course, $scale);
1609                 }
1610             }
1612             if ($ratingsmenuused) {
1613                 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1614                 echo '<input type="submit" value="'.get_string('sendinratings', 'data').'" />';
1615             }
1616             echo '</form>';
1617             echo '</div>';
1618         }
1619     }*/
1620     global $OUTPUT;
1621     if( !empty($record->rating) ){
1622         echo $OUTPUT->render($record->rating);
1623     }
1626 /**
1627  * For Participantion Reports
1628  *
1629  * @return array
1630  */
1631 function data_get_view_actions() {
1632     return array('view');
1635 /**
1636  * @return array
1637  */
1638 function data_get_post_actions() {
1639     return array('add','update','record delete');
1642 /**
1643  * @global object
1644  * @global object
1645  * @param string $name
1646  * @param int $dataid
1647  * @param int $fieldid
1648  * @return bool
1649  */
1650 function data_fieldname_exists($name, $dataid, $fieldid=0) {
1651     global $CFG, $DB;
1653     $LIKE = $DB->sql_ilike();
1654     if ($fieldid) {
1655         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1656                                         WHERE df.name $LIKE ? AND df.dataid = ?
1657                                               AND ((df.id < ?) OR (df.id > ?))", array($name, $dataid, $fieldid, $fieldid));
1658     } else {
1659         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1660                                         WHERE df.name $LIKE ? AND df.dataid = ?", array($name, $dataid));
1661     }
1664 /**
1665  * @param array $fieldinput
1666  */
1667 function data_convert_arrays_to_strings(&$fieldinput) {
1668     foreach ($fieldinput as $key => $val) {
1669         if (is_array($val)) {
1670             $str = '';
1671             foreach ($val as $inner) {
1672                 $str .= $inner . ',';
1673             }
1674             $str = substr($str, 0, -1);
1676             $fieldinput->$key = $str;
1677         }
1678     }
1682 /**
1683  * Converts a database (module instance) to use the Roles System
1684  *
1685  * @global object
1686  * @global object
1687  * @uses CONTEXT_MODULE
1688  * @uses CAP_PREVENT
1689  * @uses CAP_ALLOW
1690  * @param object $data a data object with the same attributes as a record
1691  *                     from the data database table
1692  * @param int $datamodid the id of the data module, from the modules table
1693  * @param array $teacherroles array of roles that have archetype teacher
1694  * @param array $studentroles array of roles that have archetype student
1695  * @param array $guestroles array of roles that have archetype guest
1696  * @param int $cmid the course_module id for this data instance
1697  * @return boolean data module was converted or not
1698  */
1699 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1700     global $CFG, $DB, $OUTPUT;
1702     if (!isset($data->participants) && !isset($data->assesspublic)
1703             && !isset($data->groupmode)) {
1704         // We assume that this database has already been converted to use the
1705         // Roles System. above fields get dropped the data module has been
1706         // upgraded to use Roles.
1707         return false;
1708     }
1710     if (empty($cmid)) {
1711         // We were not given the course_module id. Try to find it.
1712         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1713             echo $OUTPUT->notification('Could not get the course module for the data');
1714             return false;
1715         } else {
1716             $cmid = $cm->id;
1717         }
1718     }
1719     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1722     // $data->participants:
1723     // 1 - Only teachers can add entries
1724     // 3 - Teachers and students can add entries
1725     switch ($data->participants) {
1726         case 1:
1727             foreach ($studentroles as $studentrole) {
1728                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1729             }
1730             foreach ($teacherroles as $teacherrole) {
1731                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1732             }
1733             break;
1734         case 3:
1735             foreach ($studentroles as $studentrole) {
1736                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1737             }
1738             foreach ($teacherroles as $teacherrole) {
1739                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1740             }
1741             break;
1742     }
1744     // $data->assessed:
1745     // 2 - Only teachers can rate posts
1746     // 1 - Everyone can rate posts
1747     // 0 - No one can rate posts
1748     switch ($data->assessed) {
1749         case 0:
1750             foreach ($studentroles as $studentrole) {
1751                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1752             }
1753             foreach ($teacherroles as $teacherrole) {
1754                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1755             }
1756             break;
1757         case 1:
1758             foreach ($studentroles as $studentrole) {
1759                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1760             }
1761             foreach ($teacherroles as $teacherrole) {
1762                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1763             }
1764             break;
1765         case 2:
1766             foreach ($studentroles as $studentrole) {
1767                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1768             }
1769             foreach ($teacherroles as $teacherrole) {
1770                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1771             }
1772             break;
1773     }
1775     // $data->assesspublic:
1776     // 0 - Students can only see their own ratings
1777     // 1 - Students can see everyone's ratings
1778     switch ($data->assesspublic) {
1779         case 0:
1780             foreach ($studentroles as $studentrole) {
1781                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1782             }
1783             foreach ($teacherroles as $teacherrole) {
1784                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1785             }
1786             break;
1787         case 1:
1788             foreach ($studentroles as $studentrole) {
1789                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1790             }
1791             foreach ($teacherroles as $teacherrole) {
1792                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1793             }
1794             break;
1795     }
1797     if (empty($cm)) {
1798         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1799     }
1801     switch ($cm->groupmode) {
1802         case NOGROUPS:
1803             break;
1804         case SEPARATEGROUPS:
1805             foreach ($studentroles as $studentrole) {
1806                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1807             }
1808             foreach ($teacherroles as $teacherrole) {
1809                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1810             }
1811             break;
1812         case VISIBLEGROUPS:
1813             foreach ($studentroles as $studentrole) {
1814                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1815             }
1816             foreach ($teacherroles as $teacherrole) {
1817                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1818             }
1819             break;
1820     }
1821     return true;
1824 /**
1825  * Returns the best name to show for a preset
1826  *
1827  * @param string $shortname
1828  * @param  string $path
1829  * @return string
1830  */
1831 function data_preset_name($shortname, $path) {
1833     // We are looking inside the preset itself as a first choice, but also in normal data directory
1834     $string = get_string('modulename', 'datapreset_'.$shortname);
1836     if (substr($string, 0, 1) == '[') {
1837         return $shortname;
1838     } else {
1839         return $string;
1840     }
1843 /**
1844  * Returns an array of all the available presets.
1845  *
1846  * @return array
1847  */
1848 function data_get_available_presets($context) {
1849     global $CFG, $USER;
1851     $presets = array();
1853     // First load the ratings sub plugins that exist within the modules preset dir
1854     if ($dirs = get_list_of_plugins('mod/data/preset')) {
1855         foreach ($dirs as $dir) {
1856             $fulldir = $CFG->dirroot.'/mod/data/preset/'.$dir;
1857             if (is_directory_a_preset($fulldir)) {
1858                 $preset = new object;
1859                 $preset->path = $fulldir;
1860                 $preset->userid = 0;
1861                 $preset->shortname = $dir;
1862                 $preset->name = data_preset_name($dir, $fulldir);
1863                 if (file_exists($fulldir.'/screenshot.jpg')) {
1864                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1865                 } else if (file_exists($fulldir.'/screenshot.png')) {
1866                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1867                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1868                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1869                 }
1870                 $presets[] = $preset;
1871             }
1872         }
1873     }
1874     // Now add to that the site presets that people have saved
1875     $presets = data_get_available_site_presets($context, $presets);
1876     return $presets;
1879 /**
1880  * Gets an array of all of the presets that users have saved to the site.
1881  *
1882  * @param stdClass $context The context that we are looking from.
1883  * @param array $presets
1884  * @return array An array of presets
1885  */
1886 function data_get_available_site_presets($context, array $presets=array()) {
1887     $fs = get_file_storage();
1888     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
1889     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
1890     if (empty($files)) {
1891         return $presets;
1892     }
1893     foreach ($files as $file) {
1894         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
1895             continue;
1896         }
1897         $preset = new stdClass;
1898         $preset->path = $file->get_filepath();
1899         $preset->name = trim($preset->path, '/');
1900         $preset->shortname = $preset->name;
1901         $preset->userid = $file->get_userid();
1902         $preset->id = $file->get_id();
1903         $preset->storedfile = $file;
1904         $presets[] = $preset;
1905     }
1906     return $presets;
1909 /**
1910  * Deletes a saved preset.
1911  *
1912  * @param string $name
1913  * @return bool
1914  */
1915 function data_delete_site_preset($name) {
1916     $fs = get_file_storage();
1918     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
1919     if (!empty($files)) {
1920         foreach ($files as $file) {
1921             $file->delete();
1922         }
1923     }
1925     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
1926     if (!empty($dir)) {
1927         $dir->delete();
1928     }
1929     return true;
1932 /**
1933  * Prints the heads for a page
1934  *
1935  * @param stdClass $course
1936  * @param stdClass $cm
1937  * @param stdClass $data
1938  * @param string $currenttab
1939  */
1940 function data_print_header($course, $cm, $data, $currenttab='') {
1942     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
1944     $PAGE->set_title($data->name);
1945     echo $OUTPUT->header();
1946     echo $OUTPUT->heading(format_string($data->name));
1948 // Groups needed for Add entry tab
1949     $currentgroup = groups_get_activity_group($cm);
1950     $groupmode = groups_get_activity_groupmode($cm);
1952     // Print the tabs
1954     if ($currenttab) {
1955         include('tabs.php');
1956     }
1958     // Print any notices
1960     if (!empty($displaynoticegood)) {
1961         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
1962     } else if (!empty($displaynoticebad)) {
1963         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
1964     }
1967 /**
1968  * @global object
1969  * @param object $data
1970  * @param mixed $currentgroup
1971  * @param int $groupmode
1972  * @return bool
1973  */
1974 function data_user_can_add_entry($data, $currentgroup, $groupmode) {
1975     global $USER;
1977     if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1978         print_error('invalidcoursemodule');
1979     }
1980     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1982     if (!has_capability('mod/data:writeentry', $context) and !has_capability('mod/data:manageentries',$context)) {
1983         return false;
1984     }
1986     //if in the view only time window
1987     $now = time();
1988     if ($now>$data->timeviewfrom && $now<$data->timeviewto) {
1989         return false;
1990     }
1992     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
1993         return true;
1994     }
1996     if ($currentgroup) {
1997         return groups_is_member($currentgroup);
1998     } else {
1999         //else it might be group 0 in visible mode
2000         if ($groupmode == VISIBLEGROUPS){
2001             return true;
2002         } else {
2003             return false;
2004         }
2005     }
2009 /**
2010  * @return bool
2011  */
2012 function is_directory_a_preset($directory) {
2013     $directory = rtrim($directory, '/\\') . '/';
2014     $status = file_exists($directory.'singletemplate.html') &&
2015               file_exists($directory.'listtemplate.html') &&
2016               file_exists($directory.'listtemplateheader.html') &&
2017               file_exists($directory.'listtemplatefooter.html') &&
2018               file_exists($directory.'addtemplate.html') &&
2019               file_exists($directory.'rsstemplate.html') &&
2020               file_exists($directory.'rsstitletemplate.html') &&
2021               file_exists($directory.'csstemplate.css') &&
2022               file_exists($directory.'jstemplate.js') &&
2023               file_exists($directory.'preset.xml');
2025     return $status;
2028 /**
2029  * Abstract class used for data preset importers
2030  */
2031 abstract class data_preset_importer {
2033     protected $course;
2034     protected $cm;
2035     protected $module;
2036     protected $directory;
2038     /**
2039      * Constructor
2040      *
2041      * @param stdClass $course
2042      * @param stdClass $cm
2043      * @param stdClass $module
2044      * @param string $directory
2045      */
2046     public function __construct($course, $cm, $module, $directory) {
2047         $this->course = $course;
2048         $this->cm = $cm;
2049         $this->module = $module;
2050         $this->directory = $directory;
2051     }
2053     /**
2054      * Returns the name of the directory the preset is located in
2055      * @return string
2056      */
2057     public function get_directory() {
2058         return basename($this->directory);
2059     }
2060     /**
2061      * Gets the preset settings
2062      * @global moodle_database $DB
2063      * @return stdClass
2064      */
2065     public function get_preset_settings() {
2066         global $DB;
2068         if (!is_directory_a_preset($this->directory)) {
2069             print_error('invalidpreset', 'data', '', $this->directory);
2070         }
2072         $allowed_settings = array(
2073             'intro',
2074             'comments',
2075             'requiredentries',
2076             'requiredentriestoview',
2077             'maxentries',
2078             'rssarticles',
2079             'approval',
2080             'defaultsortdir',
2081             'defaultsort');
2083         $result = new stdClass;
2084         $result->settings = new stdClass;
2085         $result->importfields = array();
2086         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2087         if (!$result->currentfields) {
2088             $result->currentfields = array();
2089         }
2092         /* Grab XML */
2093         $presetxml = file_get_contents($this->directory.'/preset.xml');
2094         $parsedxml = xmlize($presetxml, 0);
2096         /* First, do settings. Put in user friendly array. */
2097         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2098         $result->settings = new StdClass();
2099         foreach ($settingsarray as $setting => $value) {
2100             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2101                 // unsupported setting
2102                 continue;
2103             }
2104             $result->settings->$setting = $value[0]['#'];
2105         }
2107         /* Now work out fields to user friendly array */
2108         $fieldsarray = $parsedxml['preset']['#']['field'];
2109         foreach ($fieldsarray as $field) {
2110             if (!is_array($field)) {
2111                 continue;
2112             }
2113             $f = new StdClass();
2114             foreach ($field['#'] as $param => $value) {
2115                 if (!is_array($value)) {
2116                     continue;
2117                 }
2118                 $f->$param = $value[0]['#'];
2119             }
2120             $f->dataid = $this->module->id;
2121             $f->type = clean_param($f->type, PARAM_ALPHA);
2122             $result->importfields[] = $f;
2123         }
2124         /* Now add the HTML templates to the settings array so we can update d */
2125         $result->settings->singletemplate     = file_get_contents($this->directory."/singletemplate.html");
2126         $result->settings->listtemplate       = file_get_contents($this->directory."/listtemplate.html");
2127         $result->settings->listtemplateheader = file_get_contents($this->directory."/listtemplateheader.html");
2128         $result->settings->listtemplatefooter = file_get_contents($this->directory."/listtemplatefooter.html");
2129         $result->settings->addtemplate        = file_get_contents($this->directory."/addtemplate.html");
2130         $result->settings->rsstemplate        = file_get_contents($this->directory."/rsstemplate.html");
2131         $result->settings->rsstitletemplate   = file_get_contents($this->directory."/rsstitletemplate.html");
2132         $result->settings->csstemplate        = file_get_contents($this->directory."/csstemplate.css");
2133         $result->settings->jstemplate         = file_get_contents($this->directory."/jstemplate.js");
2135         //optional
2136         if (file_exists($this->directory."/asearchtemplate.html")) {
2137             $result->settings->asearchtemplate = file_get_contents($this->directory."/asearchtemplate.html");
2138         } else {
2139             $result->settings->asearchtemplate = NULL;
2140         }
2141         $result->settings->instance = $this->module->id;
2143         return $result;
2144     }
2146     /**
2147      * Import the preset into the given database module
2148      * @return bool
2149      */
2150     function import($overwritesettings) {
2151         global $DB;
2153         $params = $this->get_preset_settings();
2154         $settings = $params->settings;
2155         $newfields = $params->importfields;
2156         $currentfields = $params->currentfields;
2157         $preservedfields = array();
2159         /* Maps fields and makes new ones */
2160         if (!empty($newfields)) {
2161             /* We require an injective mapping, and need to know what to protect */
2162             foreach ($newfields as $nid => $newfield) {
2163                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2164                 if ($cid == -1) {
2165                     continue;
2166                 }
2167                 if (array_key_exists($cid, $preservedfields)){
2168                     print_error('notinjectivemap', 'data');
2169                 }
2170                 else $preservedfields[$cid] = true;
2171             }
2173             foreach ($newfields as $nid => $newfield) {
2174                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2176                 /* A mapping. Just need to change field params. Data kept. */
2177                 if ($cid != -1 and isset($currentfields[$cid])) {
2178                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2179                     foreach ($newfield as $param => $value) {
2180                         if ($param != "id") {
2181                             $fieldobject->field->$param = $value;
2182                         }
2183                     }
2184                     unset($fieldobject->field->similarfield);
2185                     $fieldobject->update_field();
2186                     unset($fieldobject);
2187                 } else {
2188                     /* Make a new field */
2189                     include_once("field/$newfield->type/field.class.php");
2191                     if (!isset($newfield->description)) {
2192                         $newfield->description = '';
2193                     }
2194                     $classname = 'data_field_'.$newfield->type;
2195                     $fieldclass = new $classname($newfield, $this->module);
2196                     $fieldclass->insert_field();
2197                     unset($fieldclass);
2198                 }
2199             }
2200         }
2202         /* Get rid of all old unused data */
2203         if (!empty($preservedfields)) {
2204             foreach ($currentfields as $cid => $currentfield) {
2205                 if (!array_key_exists($cid, $preservedfields)) {
2206                     /* Data not used anymore so wipe! */
2207                     print "Deleting field $currentfield->name<br />";
2209                     $id = $currentfield->id;
2210                     //Why delete existing data records and related comments/ratings??
2211                     $DB->delete_records('data_content', array('fieldid'=>$id));
2212                     $DB->delete_records('data_fields', array('id'=>$id));
2213                 }
2214             }
2215         }
2217         // handle special settings here
2218         if (!empty($settings->defaultsort)) {
2219             if (is_numeric($settings->defaultsort)) {
2220                 // old broken value
2221                 $settings->defaultsort = 0;
2222             } else {
2223                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2224             }
2225         } else {
2226             $settings->defaultsort = 0;
2227         }
2229         // do we want to overwrite all current database settings?
2230         if ($overwritesettings) {
2231             // all supported settings
2232             $overwrite = array_keys((array)$settings);
2233         } else {
2234             // only templates and sorting
2235             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2236                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2237                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2238         }
2240         // now overwrite current data settings
2241         foreach ($this->module as $prop=>$unused) {
2242             if (in_array($prop, $overwrite)) {
2243                 $this->module->$prop = $settings->$prop;
2244             }
2245         }
2247         data_update_instance($this->module);
2249         return $this->cleanup();
2250     }
2252     /**
2253      * Any clean up routines should go here
2254      * @return bool
2255      */
2256     public function cleanup() {
2257         return true;
2258     }
2261 /**
2262  * Data preset importer for uploaded presets
2263  */
2264 class data_preset_upload_importer extends data_preset_importer {
2265     public function __construct($course, $cm, $module, $filepath) {
2266         global $USER;
2267         if (is_file($filepath)) {
2268             $fp = get_file_packer();
2269             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2270                 fulldelete($filepath);
2271             }
2272             $filepath .= '_extracted';
2273         }
2274         parent::__construct($course, $cm, $module, $filepath);
2275     }
2276     public function cleanup() {
2277         return fulldelete($this->directory);
2278     }
2281 /**
2282  * Data preset importer for existing presets
2283  */
2284 class data_preset_existing_importer extends data_preset_importer {
2285     protected $userid;
2286     public function __construct($course, $cm, $module, $fullname) {
2287         global $USER;
2288         list($userid, $shortname) = explode('/', $fullname, 2);
2289         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2290         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2291            throw new coding_exception('Invalid preset provided');
2292         }
2294         $this->userid = $userid;
2295         $filepath = data_preset_path($course, $userid, $shortname);
2296         parent::__construct($course, $cm, $module, $filepath);
2297     }
2298     public function get_userid() {
2299         return $this->userid;
2300     }
2303 /**
2304  * @global object
2305  * @global object
2306  * @param object $course
2307  * @param int $userid
2308  * @param string $shortname
2309  * @return string
2310  */
2311 function data_preset_path($course, $userid, $shortname) {
2312     global $USER, $CFG;
2314     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2316     $userid = (int)$userid;
2318     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2319         return $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2320     } else if ($userid == 0) {
2321         return $CFG->dirroot.'/mod/data/preset/'.$shortname;
2322     } else if ($userid < 0) {
2323         return $CFG->dataroot.'/temp/data/'.-$userid.'/'.$shortname;
2324     }
2326     return 'Does it disturb you that this code will never run?';
2329 /**
2330  * Implementation of the function for printing the form elements that control
2331  * whether the course reset functionality affects the data.
2332  *
2333  * @param $mform form passed by reference
2334  */
2335 function data_reset_course_form_definition(&$mform) {
2336     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2337     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2339     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2340     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2342     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2343     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2345     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2346     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2349 /**
2350  * Course reset form defaults.
2351  * @return array
2352  */
2353 function data_reset_course_form_defaults($course) {
2354     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2357 /**
2358  * Removes all grades from gradebook
2359  *
2360  * @global object
2361  * @global object
2362  * @param int $courseid
2363  * @param string $type optional type
2364  */
2365 function data_reset_gradebook($courseid, $type='') {
2366     global $CFG, $DB;
2368     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2369               FROM {data} d, {course_modules} cm, {modules} m
2370              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2372     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2373         foreach ($datas as $data) {
2374             data_grade_item_update($data, 'reset');
2375         }
2376     }
2379 /**
2380  * Actual implementation of the rest coures functionality, delete all the
2381  * data responses for course $data->courseid.
2382  *
2383  * @global object
2384  * @global object
2385  * @param object $data the data submitted from the reset course.
2386  * @return array status array
2387  */
2388 function data_reset_userdata($data) {
2389     global $CFG, $DB;
2390     require_once($CFG->libdir.'/filelib.php');
2391     require_once($CFG->dirroot.'/rating/lib.php');
2393     $componentstr = get_string('modulenameplural', 'data');
2394     $status = array();
2396     $allrecordssql = "SELECT r.id
2397                         FROM {data_records} r
2398                              INNER JOIN {data} d ON r.dataid = d.id
2399                        WHERE d.course = ?";
2401     $alldatassql = "SELECT d.id
2402                       FROM {data} d
2403                      WHERE d.course=?";
2405     $rm = new rating_manager();
2406     $ratingdeloptions = new stdclass();
2408     // delete entries if requested
2409     if (!empty($data->reset_data)) {
2410         //$DB->delete_records_select('data_ratings', "recordid IN ($allrecordssql)", array($data->courseid));
2411         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2412         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2413         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2415         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2416             foreach ($datas as $dataid=>$unused) {
2417                 fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$dataid");
2419                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2420                     continue;
2421                 }
2422                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2424                 $ratingdeloptions->contextid = $datacontext->id;
2425                 $rm->delete_ratings($ratingdeloptions);
2426             }
2427         }
2429         if (empty($data->reset_gradebook_grades)) {
2430             // remove all grades from gradebook
2431             data_reset_gradebook($data->courseid);
2432         }
2433         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2434     }
2436     // remove entries by users not enrolled into course
2437     if (!empty($data->reset_data_notenrolled)) {
2438         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2439                          FROM {data_records} r
2440                               JOIN {data} d ON r.dataid = d.id
2441                               LEFT JOIN {user} u ON r.userid = u.id
2442                         WHERE d.course = ? AND r.userid > 0";
2444         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2445         $notenrolled = array();
2446         $fields = array();
2447         if ($rs = $DB->get_recordset_sql($recordssql, array($data->courseid))) {
2448             foreach ($rs as $record) {
2449                 if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2450                   or !is_enrolled($course_context, $record->userid)) {
2451                     //delete ratings
2452                     //$DB->delete_records('data_ratings', array('recordid'=>$record->id));
2453                     if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2454                         continue;
2455                     }
2456                     $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2457                     $ratingdeloptions->contextid = $datacontext->id;
2458                     $ratingdeloptions->itemid = $record->id;
2459                     $rm->delete_ratings($ratingdeloptions);
2461                     $DB->delete_records('comments', array('itemid'=>$record->id, 'commentarea'=>'database_entry'));
2462                     $DB->delete_records('data_content', array('recordid'=>$record->id));
2463                     $DB->delete_records('data_records', array('id'=>$record->id));
2464                     // HACK: this is ugly - the recordid should be before the fieldid!
2465                     if (!array_key_exists($record->dataid, $fields)) {
2466                         if ($fs = $DB->get_records('data_fields', array('dataid'=>$record->dataid))) {
2467                             $fields[$record->dataid] = array_keys($fs);
2468                         } else {
2469                             $fields[$record->dataid] = array();
2470                         }
2471                     }
2472                     foreach($fields[$record->dataid] as $fieldid) {
2473                         fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$record->dataid/$fieldid/$record->id");
2474                     }
2475                     $notenrolled[$record->userid] = true;
2476                 }
2477             }
2478             $rs->close();
2479             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2480         }
2481     }
2483     // remove all ratings
2484     if (!empty($data->reset_data_ratings)) {
2485         //$DB->delete_records_select('data_ratings', "recordid IN ($allrecordssql)", array($data->courseid));
2486         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2487             foreach ($datas as $dataid=>$unused) {
2488                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2489                     continue;
2490                 }
2491                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2493                 $ratingdeloptions->contextid = $datacontext->id;
2494                 $rm->delete_ratings($ratingdeloptions);
2495             }
2496         }
2498         if (empty($data->reset_gradebook_grades)) {
2499             // remove all grades from gradebook
2500             data_reset_gradebook($data->courseid);
2501         }
2503         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2504     }
2506     // remove all comments
2507     if (!empty($data->reset_data_comments)) {
2508         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2509         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2510     }
2512     // updating dates - shift may be negative too
2513     if ($data->timeshift) {
2514         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2515         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2516     }
2518     return $status;
2521 /**
2522  * Returns all other caps used in module
2523  *
2524  * @return array
2525  */
2526 function data_get_extra_capabilities() {
2527     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');
2530 /**
2531  * @param string $feature FEATURE_xx constant for requested feature
2532  * @return mixed True if module supports feature, null if doesn't know
2533  */
2534 function data_supports($feature) {
2535     switch($feature) {
2536         case FEATURE_GROUPS:                  return true;
2537         case FEATURE_GROUPINGS:               return true;
2538         case FEATURE_GROUPMEMBERSONLY:        return true;
2539         case FEATURE_MOD_INTRO:               return true;
2540         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2541         case FEATURE_GRADE_HAS_GRADE:         return true;
2542         case FEATURE_GRADE_OUTCOMES:          return true;
2543         case FEATURE_RATE:                    return true;
2545         default: return null;
2546     }
2548 /**
2549  * @global object
2550  * @param array $export
2551  * @param string $delimiter_name
2552  * @param object $database
2553  * @param int $count
2554  * @param bool $return
2555  * @return string|void
2556  */
2557 function data_export_csv($export, $delimiter_name, $dataname, $count, $return=false) {
2558     global $CFG;
2559     require_once($CFG->libdir . '/csvlib.class.php');
2560     $delimiter = csv_import_reader::get_delimiter($delimiter_name);
2561     $filename = clean_filename("${dataname}-${count}_record");
2562     if ($count > 1) {
2563         $filename .= 's';
2564     }
2565     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2566     $filename .= clean_filename("-${delimiter_name}_separated");
2567     $filename .= '.csv';
2568     if (empty($return)) {
2569         header("Content-Type: application/download\n");
2570         header("Content-Disposition: attachment; filename=$filename");
2571         header('Expires: 0');
2572         header('Cache-Control: must-revalidate,post-check=0,pre-check=0');
2573         header('Pragma: public');
2574     }
2575     $encdelim = '&#' . ord($delimiter) . ';';
2576     $returnstr = '';
2577     foreach($export as $row) {
2578         foreach($row as $key => $column) {
2579             $row[$key] = str_replace($delimiter, $encdelim, $column);
2580         }
2581         $returnstr .= implode($delimiter, $row) . "\n";
2582     }
2583     if (empty($return)) {
2584         echo $returnstr;
2585         return;
2586     }
2587     return $returnstr;
2590 /**
2591  * @global object
2592  * @param array $export
2593  * @param string $dataname
2594  * @param int $count
2595  * @return string
2596  */
2597 function data_export_xls($export, $dataname, $count) {
2598     global $CFG;
2599     require_once("$CFG->libdir/excellib.class.php");
2600     $filename = clean_filename("${dataname}-${count}_record");
2601     if ($count > 1) {
2602         $filename .= 's';
2603     }
2604     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2605     $filename .= '.xls';
2607     $filearg = '-';
2608     $workbook = new MoodleExcelWorkbook($filearg);
2609     $workbook->send($filename);
2610     $worksheet = array();
2611     $worksheet[0] =& $workbook->add_worksheet('');
2612     $rowno = 0;
2613     foreach ($export as $row) {
2614         $colno = 0;
2615         foreach($row as $col) {
2616             $worksheet[0]->write($rowno, $colno, $col);
2617             $colno++;
2618         }
2619         $rowno++;
2620     }
2621     $workbook->close();
2622     return $filename;
2625 /**
2626  * @global object
2627  * @param array $export
2628  * @param string $dataname
2629  * @param int $count
2630  * @param string
2631  */
2632 function data_export_ods($export, $dataname, $count) {
2633     global $CFG;
2634     require_once("$CFG->libdir/odslib.class.php");
2635     $filename = clean_filename("${dataname}-${count}_record");
2636     if ($count > 1) {
2637         $filename .= 's';
2638     }
2639     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2640     $filename .= '.ods';
2641     $filearg = '-';
2642     $workbook = new MoodleODSWorkbook($filearg);
2643     $workbook->send($filename);
2644     $worksheet = array();
2645     $worksheet[0] =& $workbook->add_worksheet('');
2646     $rowno = 0;
2647     foreach ($export as $row) {
2648         $colno = 0;
2649         foreach($row as $col) {
2650             $worksheet[0]->write($rowno, $colno, $col);
2651             $colno++;
2652         }
2653         $rowno++;
2654     }
2655     $workbook->close();
2656     return $filename;
2659 /**
2660  * @global object
2661  * @param int $dataid
2662  * @param array $fields
2663  * @param array $selectedfields
2664  * @return array
2665  */
2666 function data_get_exportdata($dataid, $fields, $selectedfields) {
2667     global $DB;
2669     $exportdata = array();
2671     // populate the header in first row of export
2672     foreach($fields as $key => $field) {
2673         if (!in_array($field->field->id, $selectedfields)) {
2674             // ignore values we aren't exporting
2675             unset($fields[$key]);
2676         } else {
2677             $exportdata[0][] = $field->field->name;
2678         }
2679     }
2681     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2682     ksort($datarecords);
2683     $line = 1;
2684     foreach($datarecords as $record) {
2685         // get content indexed by fieldid
2686         if( $content = $DB->get_records('data_content', array('recordid'=>$record->id), 'fieldid', 'fieldid, content, content1, content2, content3, content4') ) {
2687             foreach($fields as $field) {
2688                 $contents = '';
2689                 if(isset($content[$field->field->id])) {
2690                     $contents = $field->export_text_value($content[$field->field->id]);
2691                 }
2692                 $exportdata[$line][] = $contents;
2693             }
2694         }
2695         $line++;
2696     }
2697     $line--;
2698     return $exportdata;
2701 /**
2702  * Lists all browsable file areas
2703  *
2704  * @param object $course
2705  * @param object $cm
2706  * @param object $context
2707  * @return array
2708  */
2709 function data_get_file_areas($course, $cm, $context) {
2710     $areas = array();
2711     return $areas;
2714 /**
2715  * Serves the data attachments. Implements needed access control ;-)
2716  *
2717  * @param object $course
2718  * @param object $cm
2719  * @param object $context
2720  * @param string $filearea
2721  * @param array $args
2722  * @param bool $forcedownload
2723  * @return bool false if file not found, does not return if found - justsend the file
2724  */
2725 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
2726     global $CFG, $DB;
2728     if ($context->contextlevel != CONTEXT_MODULE) {
2729         return false;
2730     }
2732     require_login($course, false, $cm);
2734     if ($filearea === 'content') {
2735         $contentid = (int)array_shift($args);
2737         if (!$cm = get_coursemodule_from_instance('data', $cm->instance, $course->id)) {
2738             return false;
2739         }
2741         require_course_login($course, true, $cm);
2743         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
2744             return false;
2745         }
2747         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2748             return false;
2749         }
2751         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2752             return false;
2753         }
2755         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2756             return false;
2757         }
2759         //check if approved
2760         if (!$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2761             return false;
2762         }
2764         // group access
2765         if ($record->groupid) {
2766             $groupmode = groups_get_activity_groupmode($cm, $course);
2767             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2768                 if (!groups_is_member($record->groupid)) {
2769                     return false;
2770                 }
2771             }
2772         }
2774         $fieldobj = data_get_field($field, $data, $cm);
2776         $relativepath = implode('/', $args);
2777         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
2779         if (!$fieldobj->file_ok($relativepath)) {
2780             return false;
2781         }
2783         $fs = get_file_storage();
2784         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2785             return false;
2786         }
2788         // finally send the file
2789         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
2790     }
2792     return false;
2796 function data_extend_navigation($navigation, $course, $module, $cm) {
2797     global $CFG, $OUTPUT, $USER, $DB;
2799     $rid = optional_param('rid', 0, PARAM_INT);
2801     $data = $DB->get_record('data', array('id'=>$cm->instance));
2802     $currentgroup = groups_get_activity_group($cm);
2803     $groupmode = groups_get_activity_groupmode($cm);
2805      $numentries = data_numentries($data);
2806     /// Check the number of entries required against the number of entries already made (doesn't apply to teachers)
2807     if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !has_capability('mod/data:manageentries', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2808         $data->entriesleft = $data->requiredentries - $numentries;
2809         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
2810         $entriesnode->add_class('note');
2811     }
2813     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
2814     if (!empty($rid)) {
2815         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
2816     } else {
2817         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
2818     }
2819     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'search')));
2822 /**
2823  * Adds module specific settings to the settings block
2824  *
2825  * @param settings_navigation $settings The settings navigation object
2826  * @param navigation_node $datanode The node to add module settings to
2827  */
2828 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
2829     global $PAGE, $DB, $CFG, $USER;
2831     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
2833     $currentgroup = groups_get_activity_group($PAGE->cm);
2834     $groupmode = groups_get_activity_groupmode($PAGE->cm);
2836     if (data_user_can_add_entry($data, $currentgroup, $groupmode)) { // took out participation list here!
2837         if (empty($editentry)) {
2838             $addstring = get_string('add', 'data');
2839         } else {
2840             $addstring = get_string('editentry', 'data');
2841         }
2842         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
2843     }
2845     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
2846         // The capability required to Export database records is centrally defined in 'lib.php'
2847         // and should be weaker than those required to edit Templates, Fields and Presets.
2848         $datanode->add(get_string('export', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
2849     }
2850     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
2851         $datanode->add(get_string('import'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
2852     }
2854     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
2855         $currenttab = '';
2856         if ($currenttab == 'list') {
2857             $defaultemplate = 'listtemplate';
2858         } else if ($currenttab == 'add') {
2859             $defaultemplate = 'addtemplate';
2860         } else if ($currenttab == 'asearch') {
2861             $defaultemplate = 'asearchtemplate';
2862         } else {
2863             $defaultemplate = 'singletemplate';
2864         }
2866         $templates = $datanode->add(get_string('templates', 'data'));
2868         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
2869         foreach ($templatelist as $template) {
2870             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
2871         }
2873         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
2874         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
2875     }
2877     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
2878         require_once("$CFG->libdir/rsslib.php");
2880         $string = get_string('rsstype','forum');
2882         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
2883         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2884     }
2887 /**
2888  * Save the database configuration as a preset.
2889  *
2890  * @param stdClass $course The course the database module belongs to.
2891  * @param stdClass $cm The course module record
2892  * @param stdClass $data The database record
2893  * @param string $path
2894  * @return bool
2895  */
2896 function data_presets_save($course, $cm, $data, $path) {
2897     $fs = get_file_storage();
2898     $filerecord = new stdClass;
2899     $filerecord->contextid = DATA_PRESET_CONTEXT;
2900     $filerecord->component = DATA_PRESET_COMPONENT;
2901     $filerecord->filearea = DATA_PRESET_FILEAREA;
2902     $filerecord->itemid = 0;
2903     $filerecord->filepath = '/'.$path.'/';
2905     $filerecord->filename = 'preset.xml';
2906     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
2908     $filerecord->filename = 'singletemplate.html';
2909     $fs->create_file_from_string($filerecord, $data->singletemplate);
2911     $filerecord->filename = 'listtemplateheader.html';
2912     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
2914     $filerecord->filename = 'listtemplate.html';
2915     $fs->create_file_from_string($filerecord, $data->listtemplate);
2917     $filerecord->filename = 'listtemplatefooter.html';
2918     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
2920     $filerecord->filename = 'addtemplate.html';
2921     $fs->create_file_from_string($filerecord, $data->addtemplate);
2923     $filerecord->filename = 'rsstemplate.html';
2924     $fs->create_file_from_string($filerecord, $data->rsstemplate);
2926     $filerecord->filename = 'rsstitletemplate.html';
2927     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
2929     $filerecord->filename = 'csstemplate.css';
2930     $fs->create_file_from_string($filerecord, $data->csstemplate);
2932     $filerecord->filename = 'jstemplate.js';
2933     $fs->create_file_from_string($filerecord, $data->jstemplate);
2935     $filerecord->filename = 'asearchtemplate.html';
2936     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
2938     return true;
2941 /**
2942  * Generates the XML for the database module provided
2943  *
2944  * @global moodle_database $DB
2945  * @param stdClass $course The course the database module belongs to.
2946  * @param stdClass $cm The course module record
2947  * @param stdClass $data The database record
2948  * @return string The XML for the preset
2949  */
2950 function data_presets_generate_xml($course, $cm, $data) {
2951     global $DB;
2952     
2953     // Assemble "preset.xml":
2954     $presetxmldata = "<preset>\n\n";
2956     // Raw settings are not preprocessed during saving of presets
2957     $raw_settings = array(
2958         'intro',
2959         'comments',
2960         'requiredentries',
2961         'requiredentriestoview',
2962         'maxentries',
2963         'rssarticles',
2964         'approval',
2965         'defaultsortdir'
2966     );
2968     $presetxmldata .= "<settings>\n";
2969     // First, settings that do not require any conversion
2970     foreach ($raw_settings as $setting) {
2971         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
2972     }
2974     // Now specific settings
2975     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
2976         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
2977     } else {
2978         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
2979     }
2980     $presetxmldata .= "</settings>\n\n";
2981     // Now for the fields. Grab all that are non-empty
2982     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
2983     ksort($fields);
2984     if (!empty($fields)) {
2985         foreach ($fields as $field) {
2986             $presetxmldata .= "<field>\n";
2987             foreach ($field as $key => $value) {
2988                 if ($value != '' && $key != 'id' && $key != 'dataid') {
2989                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
2990                 }
2991             }
2992             $presetxmldata .= "</field>\n\n";
2993         }
2994     }
2995     $presetxmldata .= '</preset>';
2996     return $presetxmldata;
2999 function data_presets_export($course, $cm, $data, $tostorage=false) {
3000     global $CFG, $DB;
3002     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3003     $exportsubdir = "temp/mod_data/presetexport/$presetname";
3004     make_upload_directory($exportsubdir);
3005     $exportdir = "$CFG->dataroot/$exportsubdir";
3007     // Assemble "preset.xml":
3008     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3010     // After opening a file in write mode, close it asap
3011     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3012     fwrite($presetxmlfile, $presetxmldata);
3013     fclose($presetxmlfile);
3015     // Now write the template files
3016     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3017     fwrite($singletemplate, $data->singletemplate);
3018     fclose($singletemplate);
3020     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3021     fwrite($listtemplateheader, $data->listtemplateheader);
3022     fclose($listtemplateheader);
3024     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3025     fwrite($listtemplate, $data->listtemplate);
3026     fclose($listtemplate);
3028     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3029     fwrite($listtemplatefooter, $data->listtemplatefooter);
3030     fclose($listtemplatefooter);
3032     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3033     fwrite($addtemplate, $data->addtemplate);
3034     fclose($addtemplate);
3036     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3037     fwrite($rsstemplate, $data->rsstemplate);
3038     fclose($rsstemplate);
3040     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3041     fwrite($rsstitletemplate, $data->rsstitletemplate);
3042     fclose($rsstitletemplate);
3044     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3045     fwrite($csstemplate, $data->csstemplate);
3046     fclose($csstemplate);
3048     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3049     fwrite($jstemplate, $data->jstemplate);
3050     fclose($jstemplate);
3052     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3053     fwrite($asearchtemplate, $data->asearchtemplate);
3054     fclose($asearchtemplate);
3056     // Check if all files have been generated
3057     if (! is_directory_a_preset($exportdir)) {
3058         print_error('generateerror', 'data');
3059     }
3061     $filelist = array(
3062         'preset.xml',
3063         'singletemplate.html',
3064         'listtemplateheader.html',
3065         'listtemplate.html',
3066         'listtemplatefooter.html',
3067         'addtemplate.html',
3068         'rsstemplate.html',
3069         'rsstitletemplate.html',
3070         'csstemplate.css',
3071         'jstemplate.js',
3072         'asearchtemplate.html'
3073     );
3075     foreach ($filelist as $key => $file) {
3076         $filelist[$key] = $exportdir . '/' . $filelist[$key];
3077     }
3079     $exportfile = $exportdir.'.zip';
3080     file_exists($exportfile) && unlink($exportfile);
3082     $fp = get_file_packer();
3083     $fp->archive_to_pathname($files, $archivefile);
3085     $status = zip_files($filelist, $exportfile);
3086     // ToDo: status check
3087     foreach ($filelist as $file) {
3088         unlink($file);
3089     }
3090     rmdir($exportdir);
3092     // Return the full path to the exported preset file:
3093     return $exportfile;