Merge branch 'wip-MDL-39040-master' of git://github.com/abgreeve/moodle
[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 = context_module::instance($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 stdClass();
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 .= '<label class="accesshide" for="field_'.$this->field->id.'">'.$this->field->description.'</label>';
247         $str .= '<input class="basefieldinput" type="text" name="field_'.$this->field->id.'" id="field_'.$this->field->id.'" value="'.s($content).'" />';
248         $str .= '</div>';
250         return $str;
251     }
253     /**
254      * Print the relevant form element to define the attributes for this field
255      * viewable by teachers only.
256      *
257      * @global object
258      * @global object
259      * @return void Output is echo'd
260      */
261     function display_edit_field() {
262         global $CFG, $DB, $OUTPUT;
264         if (empty($this->field)) {   // No field has been defined yet, try and make one
265             $this->define_default_field();
266         }
267         echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
269         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
270         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
271         if (empty($this->field->id)) {
272             echo '<input type="hidden" name="mode" value="add" />'."\n";
273             $savebutton = get_string('add');
274         } else {
275             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
276             echo '<input type="hidden" name="mode" value="update" />'."\n";
277             $savebutton = get_string('savechanges');
278         }
279         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
280         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
282         echo $OUTPUT->heading($this->name());
284         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
286         echo '<div class="mdl-align">';
287         echo '<input type="submit" value="'.$savebutton.'" />'."\n";
288         echo '<input type="submit" name="cancel" value="'.get_string('cancel').'" />'."\n";
289         echo '</div>';
291         echo '</form>';
293         echo $OUTPUT->box_end();
294     }
296     /**
297      * Display the content of the field in browse mode
298      *
299      * @global object
300      * @param int $recordid
301      * @param object $template
302      * @return bool|string
303      */
304     function display_browse_field($recordid, $template) {
305         global $DB;
307         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
308             if (isset($content->content)) {
309                 $options = new stdClass();
310                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
311                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
312                     //$content->content1 = FORMAT_HTML;
313                     $options->filter=false;
314                 }
315                 $options->para = false;
316                 $str = format_text($content->content, $content->content1, $options);
317             } else {
318                 $str = '';
319             }
320             return $str;
321         }
322         return false;
323     }
325     /**
326      * Update the content of one data field in the data_content table
327      * @global object
328      * @param int $recordid
329      * @param mixed $value
330      * @param string $name
331      * @return bool
332      */
333     function update_content($recordid, $value, $name=''){
334         global $DB;
336         $content = new stdClass();
337         $content->fieldid = $this->field->id;
338         $content->recordid = $recordid;
339         $content->content = clean_param($value, PARAM_NOTAGS);
341         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
342             $content->id = $oldcontent->id;
343             return $DB->update_record('data_content', $content);
344         } else {
345             return $DB->insert_record('data_content', $content);
346         }
347     }
349     /**
350      * Delete all content associated with the field
351      *
352      * @global object
353      * @param int $recordid
354      * @return bool
355      */
356     function delete_content($recordid=0) {
357         global $DB;
359         if ($recordid) {
360             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
361         } else {
362             $conditions = array('fieldid'=>$this->field->id);
363         }
365         $rs = $DB->get_recordset('data_content', $conditions);
366         if ($rs->valid()) {
367             $fs = get_file_storage();
368             foreach ($rs as $content) {
369                 $fs->delete_area_files($this->context->id, 'mod_data', 'content', $content->id);
370             }
371         }
372         $rs->close();
374         return $DB->delete_records('data_content', $conditions);
375     }
377     /**
378      * Check if a field from an add form is empty
379      *
380      * @param mixed $value
381      * @param mixed $name
382      * @return bool
383      */
384     function notemptyfield($value, $name) {
385         return !empty($value);
386     }
388     /**
389      * Just in case a field needs to print something before the whole form
390      */
391     function print_before_form() {
392     }
394     /**
395      * Just in case a field needs to print something after the whole form
396      */
397     function print_after_form() {
398     }
401     /**
402      * Returns the sortable field for the content. By default, it's just content
403      * but for some plugins, it could be content 1 - content4
404      *
405      * @return string
406      */
407     function get_sort_field() {
408         return 'content';
409     }
411     /**
412      * Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
413      *
414      * @param string $fieldname
415      * @return string $fieldname
416      */
417     function get_sort_sql($fieldname) {
418         return $fieldname;
419     }
421     /**
422      * Returns the name/type of the field
423      *
424      * @return string
425      */
426     function name() {
427         return get_string('name'.$this->type, 'data');
428     }
430     /**
431      * Prints the respective type icon
432      *
433      * @global object
434      * @return string
435      */
436     function image() {
437         global $OUTPUT;
439         $params = array('d'=>$this->data->id, 'fid'=>$this->field->id, 'mode'=>'display', 'sesskey'=>sesskey());
440         $link = new moodle_url('/mod/data/field.php', $params);
441         $str = '<a href="'.$link->out().'">';
442         $str .= '<img src="'.$OUTPUT->pix_url('field/'.$this->type, 'data') . '" ';
443         $str .= 'height="'.$this->iconheight.'" width="'.$this->iconwidth.'" alt="'.$this->type.'" title="'.$this->type.'" /></a>';
444         return $str;
445     }
447     /**
448      * Per default, it is assumed that fields support text exporting.
449      * Override this (return false) on fields not supporting text exporting.
450      *
451      * @return bool true
452      */
453     function text_export_supported() {
454         return true;
455     }
457     /**
458      * Per default, return the record's text value only from the "content" field.
459      * Override this in fields class if necesarry.
460      *
461      * @param string $record
462      * @return string
463      */
464     function export_text_value($record) {
465         if ($this->text_export_supported()) {
466             return $record->content;
467         }
468     }
470     /**
471      * @param string $relativepath
472      * @return bool false
473      */
474     function file_ok($relativepath) {
475         return false;
476     }
480 /**
481  * Given a template and a dataid, generate a default case template
482  *
483  * @global object
484  * @param object $data
485  * @param string template [addtemplate, singletemplate, listtempalte, rsstemplate]
486  * @param int $recordid
487  * @param bool $form
488  * @param bool $update
489  * @return bool|string
490  */
491 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
492     global $DB;
494     if (!$data && !$template) {
495         return false;
496     }
497     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
498         return '';
499     }
501     // get all the fields for that database
502     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
504         $table = new html_table();
505         $table->attributes['class'] = 'mod-data-default-template';
506         $table->colclasses = array('template-field', 'template-token');
507         $table->data = array();
508         foreach ($fields as $field) {
509             if ($form) {   // Print forms instead of data
510                 $fieldobj = data_get_field($field, $data);
511                 $token = $fieldobj->display_add_field($recordid);
512             } else {           // Just print the tag
513                 $token = '[['.$field->name.']]';
514             }
515             $table->data[] = array(
516                 $field->name.': ',
517                 $token
518             );
519         }
520         if ($template == 'listtemplate') {
521             $cell = new html_table_cell('##edit##  ##more##  ##delete##  ##approve##  ##export##');
522             $cell->colspan = 2;
523             $cell->attributes['class'] = 'controls';
524             $table->data[] = new html_table_row(array($cell));
525         } else if ($template == 'singletemplate') {
526             $cell = new html_table_cell('##edit##  ##delete##  ##approve##  ##export##');
527             $cell->colspan = 2;
528             $cell->attributes['class'] = 'controls';
529             $table->data[] = new html_table_row(array($cell));
530         } else if ($template == 'asearchtemplate') {
531             $row = new html_table_row(array(get_string('authorfirstname', 'data').': ', '##firstname##'));
532             $row->attributes['class'] = 'searchcontrols';
533             $table->data[] = $row;
534             $row = new html_table_row(array(get_string('authorlastname', 'data').': ', '##lastname##'));
535             $row->attributes['class'] = 'searchcontrols';
536             $table->data[] = $row;
537         }
539         $str  = html_writer::start_tag('div', array('class' => 'defaulttemplate'));
540         $str .= html_writer::table($table);
541         $str .= html_writer::end_tag('div');
542         if ($template == 'listtemplate'){
543             $str .= html_writer::empty_tag('hr');
544         }
546         if ($update) {
547             $newdata = new stdClass();
548             $newdata->id = $data->id;
549             $newdata->{$template} = $str;
550             $DB->update_record('data', $newdata);
551             $data->{$template} = $str;
552         }
554         return $str;
555     }
559 /**
560  * Search for a field name and replaces it with another one in all the
561  * form templates. Set $newfieldname as '' if you want to delete the
562  * field from the form.
563  *
564  * @global object
565  * @param object $data
566  * @param string $searchfieldname
567  * @param string $newfieldname
568  * @return bool
569  */
570 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
571     global $DB;
573     if (!empty($newfieldname)) {
574         $prestring = '[[';
575         $poststring = ']]';
576         $idpart = '#id';
578     } else {
579         $prestring = '';
580         $poststring = '';
581         $idpart = '';
582     }
584     $newdata = new stdClass();
585     $newdata->id = $data->id;
586     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
587             $prestring.$newfieldname.$poststring, $data->singletemplate);
589     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
590             $prestring.$newfieldname.$poststring, $data->listtemplate);
592     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
593             $prestring.$newfieldname.$poststring, $data->addtemplate);
595     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
596             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
598     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
599             $prestring.$newfieldname.$poststring, $data->rsstemplate);
601     return $DB->update_record('data', $newdata);
605 /**
606  * Appends a new field at the end of the form template.
607  *
608  * @global object
609  * @param object $data
610  * @param string $newfieldname
611  */
612 function data_append_new_field_to_templates($data, $newfieldname) {
613     global $DB;
615     $newdata = new stdClass();
616     $newdata->id = $data->id;
617     $change = false;
619     if (!empty($data->singletemplate)) {
620         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
621         $change = true;
622     }
623     if (!empty($data->addtemplate)) {
624         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
625         $change = true;
626     }
627     if (!empty($data->rsstemplate)) {
628         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
629         $change = true;
630     }
631     if ($change) {
632         $DB->update_record('data', $newdata);
633     }
637 /**
638  * given a field name
639  * this function creates an instance of the particular subfield class
640  *
641  * @global object
642  * @param string $name
643  * @param object $data
644  * @return object|bool
645  */
646 function data_get_field_from_name($name, $data){
647     global $DB;
649     $field = $DB->get_record('data_fields', array('name'=>$name, 'dataid'=>$data->id));
651     if ($field) {
652         return data_get_field($field, $data);
653     } else {
654         return false;
655     }
658 /**
659  * given a field id
660  * this function creates an instance of the particular subfield class
661  *
662  * @global object
663  * @param int $fieldid
664  * @param object $data
665  * @return bool|object
666  */
667 function data_get_field_from_id($fieldid, $data){
668     global $DB;
670     $field = $DB->get_record('data_fields', array('id'=>$fieldid, 'dataid'=>$data->id));
672     if ($field) {
673         return data_get_field($field, $data);
674     } else {
675         return false;
676     }
679 /**
680  * given a field id
681  * this function creates an instance of the particular subfield class
682  *
683  * @global object
684  * @param string $type
685  * @param object $data
686  * @return object
687  */
688 function data_get_field_new($type, $data) {
689     global $CFG;
691     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
692     $newfield = 'data_field_'.$type;
693     $newfield = new $newfield(0, $data);
694     return $newfield;
697 /**
698  * returns a subclass field object given a record of the field, used to
699  * invoke plugin methods
700  * input: $param $field - record from db
701  *
702  * @global object
703  * @param object $field
704  * @param object $data
705  * @param object $cm
706  * @return object
707  */
708 function data_get_field($field, $data, $cm=null) {
709     global $CFG;
711     if ($field) {
712         require_once('field/'.$field->type.'/field.class.php');
713         $newfield = 'data_field_'.$field->type;
714         $newfield = new $newfield($field, $data, $cm);
715         return $newfield;
716     }
720 /**
721  * Given record object (or id), returns true if the record belongs to the current user
722  *
723  * @global object
724  * @global object
725  * @param mixed $record record object or id
726  * @return bool
727  */
728 function data_isowner($record) {
729     global $USER, $DB;
731     if (!isloggedin()) { // perf shortcut
732         return false;
733     }
735     if (!is_object($record)) {
736         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
737             return false;
738         }
739     }
741     return ($record->userid == $USER->id);
744 /**
745  * has a user reached the max number of entries?
746  *
747  * @param object $data
748  * @return bool
749  */
750 function data_atmaxentries($data){
751     if (!$data->maxentries){
752         return false;
754     } else {
755         return (data_numentries($data) >= $data->maxentries);
756     }
759 /**
760  * returns the number of entries already made by this user
761  *
762  * @global object
763  * @global object
764  * @param object $data
765  * @return int
766  */
767 function data_numentries($data){
768     global $USER, $DB;
769     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
770     return $DB->count_records_sql($sql, array($data->id, $USER->id));
773 /**
774  * function that takes in a dataid and adds a record
775  * this is used everytime an add template is submitted
776  *
777  * @global object
778  * @global object
779  * @param object $data
780  * @param int $groupid
781  * @return bool
782  */
783 function data_add_record($data, $groupid=0){
784     global $USER, $DB;
786     $cm = get_coursemodule_from_instance('data', $data->id);
787     $context = context_module::instance($cm->id);
789     $record = new stdClass();
790     $record->userid = $USER->id;
791     $record->dataid = $data->id;
792     $record->groupid = $groupid;
793     $record->timecreated = $record->timemodified = time();
794     if (has_capability('mod/data:approve', $context)) {
795         $record->approved = 1;
796     } else {
797         $record->approved = 0;
798     }
799     return $DB->insert_record('data_records', $record);
802 /**
803  * check the multple existence any tag in a template
804  *
805  * check to see if there are 2 or more of the same tag being used.
806  *
807  * @global object
808  * @param int $dataid,
809  * @param string $template
810  * @return bool
811  */
812 function data_tags_check($dataid, $template) {
813     global $DB, $OUTPUT;
815     // first get all the possible tags
816     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
817     // then we generate strings to replace
818     $tagsok = true; // let's be optimistic
819     foreach ($fields as $field){
820         $pattern="/\[\[".$field->name."\]\]/i";
821         if (preg_match_all($pattern, $template, $dummy)>1){
822             $tagsok = false;
823             echo $OUTPUT->notification('[['.$field->name.']] - '.get_string('multipletags','data'));
824         }
825     }
826     // else return true
827     return $tagsok;
830 /**
831  * Adds an instance of a data
832  *
833  * @param stdClass $data
834  * @param mod_data_mod_form $mform
835  * @return int intance id
836  */
837 function data_add_instance($data, $mform = null) {
838     global $DB;
840     if (empty($data->assessed)) {
841         $data->assessed = 0;
842     }
844     $data->timemodified = time();
846     $data->id = $DB->insert_record('data', $data);
848     data_grade_item_update($data);
850     return $data->id;
853 /**
854  * updates an instance of a data
855  *
856  * @global object
857  * @param object $data
858  * @return bool
859  */
860 function data_update_instance($data) {
861     global $DB, $OUTPUT;
863     $data->timemodified = time();
864     $data->id           = $data->instance;
866     if (empty($data->assessed)) {
867         $data->assessed = 0;
868     }
870     if (empty($data->ratingtime) or empty($data->assessed)) {
871         $data->assesstimestart  = 0;
872         $data->assesstimefinish = 0;
873     }
875     if (empty($data->notification)) {
876         $data->notification = 0;
877     }
879     $DB->update_record('data', $data);
881     data_grade_item_update($data);
883     return true;
887 /**
888  * deletes an instance of a data
889  *
890  * @global object
891  * @param int $id
892  * @return bool
893  */
894 function data_delete_instance($id) {    // takes the dataid
895     global $DB, $CFG;
897     if (!$data = $DB->get_record('data', array('id'=>$id))) {
898         return false;
899     }
901     $cm = get_coursemodule_from_instance('data', $data->id);
902     $context = context_module::instance($cm->id);
904 /// Delete all the associated information
906     // files
907     $fs = get_file_storage();
908     $fs->delete_area_files($context->id, 'mod_data');
910     // get all the records in this data
911     $sql = "SELECT r.id
912               FROM {data_records} r
913              WHERE r.dataid = ?";
915     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
917     // delete all the records and fields
918     $DB->delete_records('data_records', array('dataid'=>$id));
919     $DB->delete_records('data_fields', array('dataid'=>$id));
921     // Delete the instance itself
922     $result = $DB->delete_records('data', array('id'=>$id));
924     // cleanup gradebook
925     data_grade_item_delete($data);
927     return $result;
930 /**
931  * returns a summary of data activity of this user
932  *
933  * @global object
934  * @param object $course
935  * @param object $user
936  * @param object $mod
937  * @param object $data
938  * @return object|null
939  */
940 function data_user_outline($course, $user, $mod, $data) {
941     global $DB, $CFG;
942     require_once("$CFG->libdir/gradelib.php");
944     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
945     if (empty($grades->items[0]->grades)) {
946         $grade = false;
947     } else {
948         $grade = reset($grades->items[0]->grades);
949     }
952     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
953         $result = new stdClass();
954         $result->info = get_string('numrecords', 'data', $countrecords);
955         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
956                                               WHERE dataid = ? AND userid = ?
957                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
958         $result->time = $lastrecord->timemodified;
959         if ($grade) {
960             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
961         }
962         return $result;
963     } else if ($grade) {
964         $result = new stdClass();
965         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
967         //datesubmitted == time created. dategraded == time modified or time overridden
968         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
969         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
970         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
971             $result->time = $grade->dategraded;
972         } else {
973             $result->time = $grade->datesubmitted;
974         }
976         return $result;
977     }
978     return NULL;
981 /**
982  * Prints all the records uploaded by this user
983  *
984  * @global object
985  * @param object $course
986  * @param object $user
987  * @param object $mod
988  * @param object $data
989  */
990 function data_user_complete($course, $user, $mod, $data) {
991     global $DB, $CFG, $OUTPUT;
992     require_once("$CFG->libdir/gradelib.php");
994     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
995     if (!empty($grades->items[0]->grades)) {
996         $grade = reset($grades->items[0]->grades);
997         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
998         if ($grade->str_feedback) {
999             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1000         }
1001     }
1003     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1004         data_print_template('singletemplate', $records, $data);
1005     }
1008 /**
1009  * Return grade for given user or all users.
1010  *
1011  * @global object
1012  * @param object $data
1013  * @param int $userid optional user id, 0 means all users
1014  * @return array array of grades, false if none
1015  */
1016 function data_get_user_grades($data, $userid=0) {
1017     global $CFG;
1019     require_once($CFG->dirroot.'/rating/lib.php');
1021     $ratingoptions = new stdClass;
1022     $ratingoptions->component = 'mod_data';
1023     $ratingoptions->ratingarea = 'entry';
1024     $ratingoptions->modulename = 'data';
1025     $ratingoptions->moduleid   = $data->id;
1027     $ratingoptions->userid = $userid;
1028     $ratingoptions->aggregationmethod = $data->assessed;
1029     $ratingoptions->scaleid = $data->scale;
1030     $ratingoptions->itemtable = 'data_records';
1031     $ratingoptions->itemtableusercolumn = 'userid';
1033     $rm = new rating_manager();
1034     return $rm->get_user_grades($ratingoptions);
1037 /**
1038  * Update activity grades
1039  *
1040  * @category grade
1041  * @param object $data
1042  * @param int $userid specific user only, 0 means all
1043  * @param bool $nullifnone
1044  */
1045 function data_update_grades($data, $userid=0, $nullifnone=true) {
1046     global $CFG, $DB;
1047     require_once($CFG->libdir.'/gradelib.php');
1049     if (!$data->assessed) {
1050         data_grade_item_update($data);
1052     } else if ($grades = data_get_user_grades($data, $userid)) {
1053         data_grade_item_update($data, $grades);
1055     } else if ($userid and $nullifnone) {
1056         $grade = new stdClass();
1057         $grade->userid   = $userid;
1058         $grade->rawgrade = NULL;
1059         data_grade_item_update($data, $grade);
1061     } else {
1062         data_grade_item_update($data);
1063     }
1066 /**
1067  * Update all grades in gradebook.
1068  *
1069  * @global object
1070  */
1071 function data_upgrade_grades() {
1072     global $DB;
1074     $sql = "SELECT COUNT('x')
1075               FROM {data} d, {course_modules} cm, {modules} m
1076              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1077     $count = $DB->count_records_sql($sql);
1079     $sql = "SELECT d.*, cm.idnumber AS cmidnumber, d.course AS courseid
1080               FROM {data} d, {course_modules} cm, {modules} m
1081              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1082     $rs = $DB->get_recordset_sql($sql);
1083     if ($rs->valid()) {
1084         // too much debug output
1085         $pbar = new progress_bar('dataupgradegrades', 500, true);
1086         $i=0;
1087         foreach ($rs as $data) {
1088             $i++;
1089             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
1090             data_update_grades($data, 0, false);
1091             $pbar->update($i, $count, "Updating Database grades ($i/$count).");
1092         }
1093     }
1094     $rs->close();
1097 /**
1098  * Update/create grade item for given data
1099  *
1100  * @category grade
1101  * @param stdClass $data A database instance with extra cmidnumber property
1102  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1103  * @return object grade_item
1104  */
1105 function data_grade_item_update($data, $grades=NULL) {
1106     global $CFG;
1107     require_once($CFG->libdir.'/gradelib.php');
1109     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1111     if (!$data->assessed or $data->scale == 0) {
1112         $params['gradetype'] = GRADE_TYPE_NONE;
1114     } else if ($data->scale > 0) {
1115         $params['gradetype'] = GRADE_TYPE_VALUE;
1116         $params['grademax']  = $data->scale;
1117         $params['grademin']  = 0;
1119     } else if ($data->scale < 0) {
1120         $params['gradetype'] = GRADE_TYPE_SCALE;
1121         $params['scaleid']   = -$data->scale;
1122     }
1124     if ($grades  === 'reset') {
1125         $params['reset'] = true;
1126         $grades = NULL;
1127     }
1129     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1132 /**
1133  * Delete grade item for given data
1134  *
1135  * @category grade
1136  * @param object $data object
1137  * @return object grade_item
1138  */
1139 function data_grade_item_delete($data) {
1140     global $CFG;
1141     require_once($CFG->libdir.'/gradelib.php');
1143     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1146 // junk functions
1147 /**
1148  * takes a list of records, the current data, a search string,
1149  * and mode to display prints the translated template
1150  *
1151  * @global object
1152  * @global object
1153  * @param string $template
1154  * @param array $records
1155  * @param object $data
1156  * @param string $search
1157  * @param int $page
1158  * @param bool $return
1159  * @return mixed
1160  */
1161 function data_print_template($template, $records, $data, $search='', $page=0, $return=false) {
1162     global $CFG, $DB, $OUTPUT;
1163     $cm = get_coursemodule_from_instance('data', $data->id);
1164     $context = context_module::instance($cm->id);
1166     static $fields = NULL;
1167     static $isteacher;
1168     static $dataid = NULL;
1170     if (empty($dataid)) {
1171         $dataid = $data->id;
1172     } else if ($dataid != $data->id) {
1173         $fields = NULL;
1174     }
1176     if (empty($fields)) {
1177         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1178         foreach ($fieldrecords as $fieldrecord) {
1179             $fields[]= data_get_field($fieldrecord, $data);
1180         }
1181         $isteacher = has_capability('mod/data:managetemplates', $context);
1182     }
1184     if (empty($records)) {
1185         return;
1186     }
1188     // Check whether this activity is read-only at present
1189     $readonly = data_in_readonly_period($data);
1191     foreach ($records as $record) {   // Might be just one for the single template
1193     // Replacing tags
1194         $patterns = array();
1195         $replacement = array();
1197     // Then we generate strings to replace for normal tags
1198         foreach ($fields as $field) {
1199             $patterns[]='[['.$field->field->name.']]';
1200             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1201         }
1203     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1204         $patterns[]='##edit##';
1205         $patterns[]='##delete##';
1206         if (has_capability('mod/data:manageentries', $context) || (!$readonly && data_isowner($record->id))) {
1207             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1208                              .$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>';
1209             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1210                              .$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>';
1211         } else {
1212             $replacement[] = '';
1213             $replacement[] = '';
1214         }
1216         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1217         if ($search) {
1218             $moreurl .= '&amp;filter=1';
1219         }
1220         $patterns[]='##more##';
1221         $replacement[] = '<a href="'.$moreurl.'"><img src="'.$OUTPUT->pix_url('t/preview').
1222                         '" class="iconsmall" alt="'.get_string('more', 'data').'" title="'.get_string('more', 'data').
1223                         '" /></a>';
1225         $patterns[]='##moreurl##';
1226         $replacement[] = $moreurl;
1228         $patterns[]='##user##';
1229         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1230                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1232         $patterns[]='##export##';
1234         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1235             && ((has_capability('mod/data:exportentry', $context)
1236                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1237             require_once($CFG->libdir . '/portfoliolib.php');
1238             $button = new portfolio_add_button();
1239             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), 'mod_data');
1240             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1241             $button->set_formats($formats);
1242             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1243         } else {
1244             $replacement[] = '';
1245         }
1247         $patterns[] = '##timeadded##';
1248         $replacement[] = userdate($record->timecreated);
1250         $patterns[] = '##timemodified##';
1251         $replacement [] = userdate($record->timemodified);
1253         $patterns[]='##approve##';
1254         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)) {
1255             $approveurl = new moodle_url('/mod/data/view.php',
1256                     array('d' => $data->id, 'approve' => $record->id, 'sesskey' => sesskey()));
1257             $approveicon = new pix_icon('t/approve', get_string('approve'), '', array('class' => 'iconsmall'));
1258             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($approveurl, $approveicon),
1259                     array('class' => 'approve'));
1260         } else {
1261             $replacement[] = '';
1262         }
1264         $patterns[]='##comments##';
1265         if (($template == 'listtemplate') && ($data->comments)) {
1267             if (!empty($CFG->usecomments)) {
1268                 require_once($CFG->dirroot  . '/comment/lib.php');
1269                 list($context, $course, $cm) = get_context_info_array($context->id);
1270                 $cmt = new stdClass();
1271                 $cmt->context = $context;
1272                 $cmt->course  = $course;
1273                 $cmt->cm      = $cm;
1274                 $cmt->area    = 'database_entry';
1275                 $cmt->itemid  = $record->id;
1276                 $cmt->showcount = true;
1277                 $cmt->component = 'mod_data';
1278                 $comment = new comment($cmt);
1279                 $replacement[] = $comment->output(true);
1280             }
1281         } else {
1282             $replacement[] = '';
1283         }
1285         // actual replacement of the tags
1286         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1288         // no more html formatting and filtering - see MDL-6635
1289         if ($return) {
1290             return $newtext;
1291         } else {
1292             echo $newtext;
1294             // hack alert - return is always false in singletemplate anyway ;-)
1295             /**********************************
1296              *    Printing Ratings Form       *
1297              *********************************/
1298             if ($template == 'singletemplate') {    //prints ratings options
1299                 data_print_ratings($data, $record);
1300             }
1302             /**********************************
1303              *    Printing Comments Form       *
1304              *********************************/
1305             if (($template == 'singletemplate') && ($data->comments)) {
1306                 if (!empty($CFG->usecomments)) {
1307                     require_once($CFG->dirroot . '/comment/lib.php');
1308                     list($context, $course, $cm) = get_context_info_array($context->id);
1309                     $cmt = new stdClass();
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                     $cmt->component = 'mod_data';
1317                     $comment = new comment($cmt);
1318                     $comment->output(false);
1319                 }
1320             }
1321         }
1322     }
1325 /**
1326  * Return rating related permissions
1327  *
1328  * @param string $contextid the context id
1329  * @param string $component the component to get rating permissions for
1330  * @param string $ratingarea the rating area to get permissions for
1331  * @return array an associative array of the user's rating permissions
1332  */
1333 function data_rating_permissions($contextid, $component, $ratingarea) {
1334     $context = context::instance_by_id($contextid, MUST_EXIST);
1335     if ($component != 'mod_data' || $ratingarea != 'entry') {
1336         return null;
1337     }
1338     return array(
1339         'view'    => has_capability('mod/data:viewrating',$context),
1340         'viewany' => has_capability('mod/data:viewanyrating',$context),
1341         'viewall' => has_capability('mod/data:viewallratings',$context),
1342         'rate'    => has_capability('mod/data:rate',$context)
1343     );
1346 /**
1347  * Validates a submitted rating
1348  * @param array $params submitted data
1349  *            context => object the context in which the rated items exists [required]
1350  *            itemid => int the ID of the object being rated
1351  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1352  *            rating => int the submitted rating
1353  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1354  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1355  * @return boolean true if the rating is valid. Will throw rating_exception if not
1356  */
1357 function data_rating_validate($params) {
1358     global $DB, $USER;
1360     // Check the component is mod_data
1361     if ($params['component'] != 'mod_data') {
1362         throw new rating_exception('invalidcomponent');
1363     }
1365     // Check the ratingarea is entry (the only rating area in data module)
1366     if ($params['ratingarea'] != 'entry') {
1367         throw new rating_exception('invalidratingarea');
1368     }
1370     // Check the rateduserid is not the current user .. you can't rate your own entries
1371     if ($params['rateduserid'] == $USER->id) {
1372         throw new rating_exception('nopermissiontorate');
1373     }
1375     $datasql = "SELECT d.id as dataid, d.scale, d.course, r.userid as userid, d.approval, r.approved, r.timecreated, d.assesstimestart, d.assesstimefinish, r.groupid
1376                   FROM {data_records} r
1377                   JOIN {data} d ON r.dataid = d.id
1378                  WHERE r.id = :itemid";
1379     $dataparams = array('itemid'=>$params['itemid']);
1380     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1381         //item doesn't exist
1382         throw new rating_exception('invaliditemid');
1383     }
1385     if ($info->scale != $params['scaleid']) {
1386         //the scale being submitted doesnt match the one in the database
1387         throw new rating_exception('invalidscaleid');
1388     }
1390     //check that the submitted rating is valid for the scale
1392     // lower limit
1393     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1394         throw new rating_exception('invalidnum');
1395     }
1397     // upper limit
1398     if ($info->scale < 0) {
1399         //its a custom scale
1400         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1401         if ($scalerecord) {
1402             $scalearray = explode(',', $scalerecord->scale);
1403             if ($params['rating'] > count($scalearray)) {
1404                 throw new rating_exception('invalidnum');
1405             }
1406         } else {
1407             throw new rating_exception('invalidscaleid');
1408         }
1409     } else if ($params['rating'] > $info->scale) {
1410         //if its numeric and submitted rating is above maximum
1411         throw new rating_exception('invalidnum');
1412     }
1414     if ($info->approval && !$info->approved) {
1415         //database requires approval but this item isnt approved
1416         throw new rating_exception('nopermissiontorate');
1417     }
1419     // check the item we're rating was created in the assessable time window
1420     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1421         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1422             throw new rating_exception('notavailable');
1423         }
1424     }
1426     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1427     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1428     $context = context_module::instance($cm->id);
1430     // if the supplied context doesnt match the item's context
1431     if ($context->id != $params['context']->id) {
1432         throw new rating_exception('invalidcontext');
1433     }
1435     // Make sure groups allow this user to see the item they're rating
1436     $groupid = $info->groupid;
1437     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1438         if (!groups_group_exists($groupid)) { // Can't find group
1439             throw new rating_exception('cannotfindgroup');//something is wrong
1440         }
1442         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1443             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1444             throw new rating_exception('notmemberofgroup');
1445         }
1446     }
1448     return true;
1452 /**
1453  * function that takes in the current data, number of items per page,
1454  * a search string and prints a preference box in view.php
1455  *
1456  * This preference box prints a searchable advanced search template if
1457  *     a) A template is defined
1458  *  b) The advanced search checkbox is checked.
1459  *
1460  * @global object
1461  * @global object
1462  * @param object $data
1463  * @param int $perpage
1464  * @param string $search
1465  * @param string $sort
1466  * @param string $order
1467  * @param array $search_array
1468  * @param int $advanced
1469  * @param string $mode
1470  * @return void
1471  */
1472 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1473     global $CFG, $DB, $PAGE, $OUTPUT;
1475     $cm = get_coursemodule_from_instance('data', $data->id);
1476     $context = context_module::instance($cm->id);
1477     echo '<br /><div class="datapreferences">';
1478     echo '<form id="options" action="view.php" method="get">';
1479     echo '<div>';
1480     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1481     if ($mode =='asearch') {
1482         $advanced = 1;
1483         echo '<input type="hidden" name="mode" value="list" />';
1484     }
1485     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1486     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1487                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1488     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id'=>'pref_perpage'));
1490     if ($advanced) {
1491         $regsearchclass = 'search_none';
1492         $advancedsearchclass = 'search_inline';
1493     } else {
1494         $regsearchclass = 'search_inline';
1495         $advancedsearchclass = 'search_none';
1496     }
1497     echo '<div id="reg_search" class="' . $regsearchclass . '" >&nbsp;&nbsp;&nbsp;';
1498     echo '<label for="pref_search">'.get_string('search').'</label> <input type="text" size="16" name="search" id= "pref_search" value="'.s($search).'" /></div>';
1499     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1500     // foreach field, print the option
1501     echo '<select name="sort" id="pref_sortby">';
1502     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1503         echo '<optgroup label="'.get_string('fields', 'data').'">';
1504         foreach ($fields as $field) {
1505             if ($field->id == $sort) {
1506                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1507             } else {
1508                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1509             }
1510         }
1511         echo '</optgroup>';
1512     }
1513     $options = array();
1514     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1515     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1516     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1517     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1518     if ($data->approval and has_capability('mod/data:approve', $context)) {
1519         $options[DATA_APPROVED] = get_string('approved', 'data');
1520     }
1521     echo '<optgroup label="'.get_string('other', 'data').'">';
1522     foreach ($options as $key => $name) {
1523         if ($key == $sort) {
1524             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1525         } else {
1526             echo '<option value="'.$key.'">'.$name.'</option>';
1527         }
1528     }
1529     echo '</optgroup>';
1530     echo '</select>';
1531     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1532     echo '<select id="pref_order" name="order">';
1533     if ($order == 'ASC') {
1534         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1535     } else {
1536         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1537     }
1538     if ($order == 'DESC') {
1539         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1540     } else {
1541         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1542     }
1543     echo '</select>';
1545     if ($advanced) {
1546         $checked = ' checked="checked" ';
1547     }
1548     else {
1549         $checked = '';
1550     }
1551     $PAGE->requires->js('/mod/data/data.js');
1552     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1553     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1554     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1555     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1557     echo '<br />';
1558     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1559     echo '<table class="boxaligncenter">';
1561     // print ASC or DESC
1562     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1563     $i = 0;
1565     // Determine if we are printing all fields for advanced search, or the template for advanced search
1566     // If a template is not defined, use the deafault template and display all fields.
1567     if(empty($data->asearchtemplate)) {
1568         data_generate_default_template($data, 'asearchtemplate');
1569     }
1571     static $fields = NULL;
1572     static $isteacher;
1573     static $dataid = NULL;
1575     if (empty($dataid)) {
1576         $dataid = $data->id;
1577     } else if ($dataid != $data->id) {
1578         $fields = NULL;
1579     }
1581     if (empty($fields)) {
1582         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1583         foreach ($fieldrecords as $fieldrecord) {
1584             $fields[]= data_get_field($fieldrecord, $data);
1585         }
1587         $isteacher = has_capability('mod/data:managetemplates', $context);
1588     }
1590     // Replacing tags
1591     $patterns = array();
1592     $replacement = array();
1594     // Then we generate strings to replace for normal tags
1595     foreach ($fields as $field) {
1596         $fieldname = $field->field->name;
1597         $fieldname = preg_quote($fieldname, '/');
1598         $patterns[] = "/\[\[$fieldname\]\]/i";
1599         $searchfield = data_get_field_from_id($field->field->id, $data);
1600         if (!empty($search_array[$field->field->id]->data)) {
1601             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1602         } else {
1603             $replacement[] = $searchfield->display_search_field();
1604         }
1605     }
1606     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1607     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1608     $patterns[]    = '/##firstname##/';
1609     $replacement[] = '<label class="accesshide" for="u_fn">'.get_string('authorfirstname', 'data').'</label><input type="text" size="16" id="u_fn" name="u_fn" value="'.$fn.'" />';
1610     $patterns[]    = '/##lastname##/';
1611     $replacement[] = '<label class="accesshide" for="u_ln">'.get_string('authorlastname', 'data').'</label><input type="text" size="16" id="u_ln" name="u_ln" value="'.$ln.'" />';
1613     // actual replacement of the tags
1614     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1616     $options = new stdClass();
1617     $options->para=false;
1618     $options->noclean=true;
1619     echo '<tr><td>';
1620     echo format_text($newtext, FORMAT_HTML, $options);
1621     echo '</td></tr>';
1623     echo '<tr><td colspan="4"><br/><input type="submit" value="'.get_string('savesettings','data').'" /><input type="submit" name="resetadv" value="'.get_string('resetsettings','data').'" /></td></tr>';
1624     echo '</table>';
1625     echo '</div>';
1626     echo '</div>';
1627     echo '</form>';
1628     echo '</div>';
1631 /**
1632  * @global object
1633  * @global object
1634  * @param object $data
1635  * @param object $record
1636  * @return void Output echo'd
1637  */
1638 function data_print_ratings($data, $record) {
1639     global $OUTPUT;
1640     if (!empty($record->rating)){
1641         echo $OUTPUT->render($record->rating);
1642     }
1645 /**
1646  * For Participantion Reports
1647  *
1648  * @return array
1649  */
1650 function data_get_view_actions() {
1651     return array('view');
1654 /**
1655  * @return array
1656  */
1657 function data_get_post_actions() {
1658     return array('add','update','record delete');
1661 /**
1662  * @param string $name
1663  * @param int $dataid
1664  * @param int $fieldid
1665  * @return bool
1666  */
1667 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
1668     global $DB;
1670     if (!is_numeric($name)) {
1671         $like = $DB->sql_like('df.name', ':name', false);
1672     } else {
1673         $like = "df.name = :name";
1674     }
1675     $params = array('name'=>$name);
1676     if ($fieldid) {
1677         $params['dataid']   = $dataid;
1678         $params['fieldid1'] = $fieldid;
1679         $params['fieldid2'] = $fieldid;
1680         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1681                                         WHERE $like AND df.dataid = :dataid
1682                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
1683     } else {
1684         $params['dataid']   = $dataid;
1685         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1686                                         WHERE $like AND df.dataid = :dataid", $params);
1687     }
1690 /**
1691  * @param array $fieldinput
1692  */
1693 function data_convert_arrays_to_strings(&$fieldinput) {
1694     foreach ($fieldinput as $key => $val) {
1695         if (is_array($val)) {
1696             $str = '';
1697             foreach ($val as $inner) {
1698                 $str .= $inner . ',';
1699             }
1700             $str = substr($str, 0, -1);
1702             $fieldinput->$key = $str;
1703         }
1704     }
1708 /**
1709  * Converts a database (module instance) to use the Roles System
1710  *
1711  * @global object
1712  * @global object
1713  * @uses CONTEXT_MODULE
1714  * @uses CAP_PREVENT
1715  * @uses CAP_ALLOW
1716  * @param object $data a data object with the same attributes as a record
1717  *                     from the data database table
1718  * @param int $datamodid the id of the data module, from the modules table
1719  * @param array $teacherroles array of roles that have archetype teacher
1720  * @param array $studentroles array of roles that have archetype student
1721  * @param array $guestroles array of roles that have archetype guest
1722  * @param int $cmid the course_module id for this data instance
1723  * @return boolean data module was converted or not
1724  */
1725 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1726     global $CFG, $DB, $OUTPUT;
1728     if (!isset($data->participants) && !isset($data->assesspublic)
1729             && !isset($data->groupmode)) {
1730         // We assume that this database has already been converted to use the
1731         // Roles System. above fields get dropped the data module has been
1732         // upgraded to use Roles.
1733         return false;
1734     }
1736     if (empty($cmid)) {
1737         // We were not given the course_module id. Try to find it.
1738         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1739             echo $OUTPUT->notification('Could not get the course module for the data');
1740             return false;
1741         } else {
1742             $cmid = $cm->id;
1743         }
1744     }
1745     $context = context_module::instance($cmid);
1748     // $data->participants:
1749     // 1 - Only teachers can add entries
1750     // 3 - Teachers and students can add entries
1751     switch ($data->participants) {
1752         case 1:
1753             foreach ($studentroles as $studentrole) {
1754                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1755             }
1756             foreach ($teacherroles as $teacherrole) {
1757                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1758             }
1759             break;
1760         case 3:
1761             foreach ($studentroles as $studentrole) {
1762                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1763             }
1764             foreach ($teacherroles as $teacherrole) {
1765                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1766             }
1767             break;
1768     }
1770     // $data->assessed:
1771     // 2 - Only teachers can rate posts
1772     // 1 - Everyone can rate posts
1773     // 0 - No one can rate posts
1774     switch ($data->assessed) {
1775         case 0:
1776             foreach ($studentroles as $studentrole) {
1777                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1778             }
1779             foreach ($teacherroles as $teacherrole) {
1780                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1781             }
1782             break;
1783         case 1:
1784             foreach ($studentroles as $studentrole) {
1785                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1786             }
1787             foreach ($teacherroles as $teacherrole) {
1788                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1789             }
1790             break;
1791         case 2:
1792             foreach ($studentroles as $studentrole) {
1793                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1794             }
1795             foreach ($teacherroles as $teacherrole) {
1796                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1797             }
1798             break;
1799     }
1801     // $data->assesspublic:
1802     // 0 - Students can only see their own ratings
1803     // 1 - Students can see everyone's ratings
1804     switch ($data->assesspublic) {
1805         case 0:
1806             foreach ($studentroles as $studentrole) {
1807                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1808             }
1809             foreach ($teacherroles as $teacherrole) {
1810                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1811             }
1812             break;
1813         case 1:
1814             foreach ($studentroles as $studentrole) {
1815                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1816             }
1817             foreach ($teacherroles as $teacherrole) {
1818                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1819             }
1820             break;
1821     }
1823     if (empty($cm)) {
1824         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1825     }
1827     switch ($cm->groupmode) {
1828         case NOGROUPS:
1829             break;
1830         case SEPARATEGROUPS:
1831             foreach ($studentroles as $studentrole) {
1832                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1833             }
1834             foreach ($teacherroles as $teacherrole) {
1835                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1836             }
1837             break;
1838         case VISIBLEGROUPS:
1839             foreach ($studentroles as $studentrole) {
1840                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1841             }
1842             foreach ($teacherroles as $teacherrole) {
1843                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1844             }
1845             break;
1846     }
1847     return true;
1850 /**
1851  * Returns the best name to show for a preset
1852  *
1853  * @param string $shortname
1854  * @param  string $path
1855  * @return string
1856  */
1857 function data_preset_name($shortname, $path) {
1859     // We are looking inside the preset itself as a first choice, but also in normal data directory
1860     $string = get_string('modulename', 'datapreset_'.$shortname);
1862     if (substr($string, 0, 1) == '[') {
1863         return $shortname;
1864     } else {
1865         return $string;
1866     }
1869 /**
1870  * Returns an array of all the available presets.
1871  *
1872  * @return array
1873  */
1874 function data_get_available_presets($context) {
1875     global $CFG, $USER;
1877     $presets = array();
1879     // First load the ratings sub plugins that exist within the modules preset dir
1880     if ($dirs = get_plugin_list('datapreset')) {
1881         foreach ($dirs as $dir=>$fulldir) {
1882             if (is_directory_a_preset($fulldir)) {
1883                 $preset = new stdClass();
1884                 $preset->path = $fulldir;
1885                 $preset->userid = 0;
1886                 $preset->shortname = $dir;
1887                 $preset->name = data_preset_name($dir, $fulldir);
1888                 if (file_exists($fulldir.'/screenshot.jpg')) {
1889                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1890                 } else if (file_exists($fulldir.'/screenshot.png')) {
1891                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1892                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1893                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1894                 }
1895                 $presets[] = $preset;
1896             }
1897         }
1898     }
1899     // Now add to that the site presets that people have saved
1900     $presets = data_get_available_site_presets($context, $presets);
1901     return $presets;
1904 /**
1905  * Gets an array of all of the presets that users have saved to the site.
1906  *
1907  * @param stdClass $context The context that we are looking from.
1908  * @param array $presets
1909  * @return array An array of presets
1910  */
1911 function data_get_available_site_presets($context, array $presets=array()) {
1912     global $USER;
1914     $fs = get_file_storage();
1915     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
1916     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
1917     if (empty($files)) {
1918         return $presets;
1919     }
1920     foreach ($files as $file) {
1921         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
1922             continue;
1923         }
1924         $preset = new stdClass;
1925         $preset->path = $file->get_filepath();
1926         $preset->name = trim($preset->path, '/');
1927         $preset->shortname = $preset->name;
1928         $preset->userid = $file->get_userid();
1929         $preset->id = $file->get_id();
1930         $preset->storedfile = $file;
1931         $presets[] = $preset;
1932     }
1933     return $presets;
1936 /**
1937  * Deletes a saved preset.
1938  *
1939  * @param string $name
1940  * @return bool
1941  */
1942 function data_delete_site_preset($name) {
1943     $fs = get_file_storage();
1945     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
1946     if (!empty($files)) {
1947         foreach ($files as $file) {
1948             $file->delete();
1949         }
1950     }
1952     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
1953     if (!empty($dir)) {
1954         $dir->delete();
1955     }
1956     return true;
1959 /**
1960  * Prints the heads for a page
1961  *
1962  * @param stdClass $course
1963  * @param stdClass $cm
1964  * @param stdClass $data
1965  * @param string $currenttab
1966  */
1967 function data_print_header($course, $cm, $data, $currenttab='') {
1969     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
1971     $PAGE->set_title($data->name);
1972     echo $OUTPUT->header();
1973     echo $OUTPUT->heading(format_string($data->name));
1975 // Groups needed for Add entry tab
1976     $currentgroup = groups_get_activity_group($cm);
1977     $groupmode = groups_get_activity_groupmode($cm);
1979     echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro');
1981     // Print the tabs
1983     if ($currenttab) {
1984         include('tabs.php');
1985     }
1987     // Print any notices
1989     if (!empty($displaynoticegood)) {
1990         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
1991     } else if (!empty($displaynoticebad)) {
1992         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
1993     }
1996 /**
1997  * Can user add more entries?
1998  *
1999  * @param object $data
2000  * @param mixed $currentgroup
2001  * @param int $groupmode
2002  * @param stdClass $context
2003  * @return bool
2004  */
2005 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2006     global $USER;
2008     if (empty($context)) {
2009         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2010         $context = context_module::instance($cm->id);
2011     }
2013     if (has_capability('mod/data:manageentries', $context)) {
2014         // no entry limits apply if user can manage
2016     } else if (!has_capability('mod/data:writeentry', $context)) {
2017         return false;
2019     } else if (data_atmaxentries($data)) {
2020         return false;
2021     } else if (data_in_readonly_period($data)) {
2022         // Check whether we're in a read-only period
2023         return false;
2024     }
2026     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2027         return true;
2028     }
2030     if ($currentgroup) {
2031         return groups_is_member($currentgroup);
2032     } else {
2033         //else it might be group 0 in visible mode
2034         if ($groupmode == VISIBLEGROUPS){
2035             return true;
2036         } else {
2037             return false;
2038         }
2039     }
2042 /**
2043  * Check whether the specified database activity is currently in a read-only period
2044  *
2045  * @param object $data
2046  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2047  */
2048 function data_in_readonly_period($data) {
2049     $now = time();
2050     if (!$data->timeviewfrom && !$data->timeviewto) {
2051         return false;
2052     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2053         return false;
2054     }
2055     return true;
2058 /**
2059  * @return bool
2060  */
2061 function is_directory_a_preset($directory) {
2062     $directory = rtrim($directory, '/\\') . '/';
2063     $status = file_exists($directory.'singletemplate.html') &&
2064               file_exists($directory.'listtemplate.html') &&
2065               file_exists($directory.'listtemplateheader.html') &&
2066               file_exists($directory.'listtemplatefooter.html') &&
2067               file_exists($directory.'addtemplate.html') &&
2068               file_exists($directory.'rsstemplate.html') &&
2069               file_exists($directory.'rsstitletemplate.html') &&
2070               file_exists($directory.'csstemplate.css') &&
2071               file_exists($directory.'jstemplate.js') &&
2072               file_exists($directory.'preset.xml');
2074     return $status;
2077 /**
2078  * Abstract class used for data preset importers
2079  */
2080 abstract class data_preset_importer {
2082     protected $course;
2083     protected $cm;
2084     protected $module;
2085     protected $directory;
2087     /**
2088      * Constructor
2089      *
2090      * @param stdClass $course
2091      * @param stdClass $cm
2092      * @param stdClass $module
2093      * @param string $directory
2094      */
2095     public function __construct($course, $cm, $module, $directory) {
2096         $this->course = $course;
2097         $this->cm = $cm;
2098         $this->module = $module;
2099         $this->directory = $directory;
2100     }
2102     /**
2103      * Returns the name of the directory the preset is located in
2104      * @return string
2105      */
2106     public function get_directory() {
2107         return basename($this->directory);
2108     }
2110     /**
2111      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2112      * @param file_storage $filestorage. should be null if using a conventional directory
2113      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2114      * @param string $dir the directory to look in. null if using the Moodle file storage
2115      * @param string $filename the name of the file we want
2116      * @return string the contents of the file or null if the file doesn't exist.
2117      */
2118     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2119         if(empty($filestorage) || empty($fileobj)) {
2120             if (substr($dir, -1)!='/') {
2121                 $dir .= '/';
2122             }
2123             if (file_exists($dir.$filename)) {
2124                 return file_get_contents($dir.$filename);
2125             } else {
2126                 return null;
2127             }
2128         } else {
2129             if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
2130                 $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2131                 return $file->get_content();
2132             } else {
2133                 return null;
2134             }
2135         }
2137     }
2138     /**
2139      * Gets the preset settings
2140      * @global moodle_database $DB
2141      * @return stdClass
2142      */
2143     public function get_preset_settings() {
2144         global $DB;
2146         $fs = $fileobj = null;
2147         if (!is_directory_a_preset($this->directory)) {
2148             //maybe the user requested a preset stored in the Moodle file storage
2150             $fs = get_file_storage();
2151             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2153             //preset name to find will be the final element of the directory
2154             $explodeddirectory = explode('/', $this->directory);
2155             $presettofind = end($explodeddirectory);
2157             //now go through the available files available and see if we can find it
2158             foreach ($files as $file) {
2159                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2160                     continue;
2161                 }
2162                 $presetname = trim($file->get_filepath(), '/');
2163                 if ($presetname==$presettofind) {
2164                     $this->directory = $presetname;
2165                     $fileobj = $file;
2166                 }
2167             }
2169             if (empty($fileobj)) {
2170                 print_error('invalidpreset', 'data', '', $this->directory);
2171             }
2172         }
2174         $allowed_settings = array(
2175             'intro',
2176             'comments',
2177             'requiredentries',
2178             'requiredentriestoview',
2179             'maxentries',
2180             'rssarticles',
2181             'approval',
2182             'defaultsortdir',
2183             'defaultsort');
2185         $result = new stdClass;
2186         $result->settings = new stdClass;
2187         $result->importfields = array();
2188         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2189         if (!$result->currentfields) {
2190             $result->currentfields = array();
2191         }
2194         /* Grab XML */
2195         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2196         $parsedxml = xmlize($presetxml, 0);
2198         /* First, do settings. Put in user friendly array. */
2199         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2200         $result->settings = new StdClass();
2201         foreach ($settingsarray as $setting => $value) {
2202             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2203                 // unsupported setting
2204                 continue;
2205             }
2206             $result->settings->$setting = $value[0]['#'];
2207         }
2209         /* Now work out fields to user friendly array */
2210         $fieldsarray = $parsedxml['preset']['#']['field'];
2211         foreach ($fieldsarray as $field) {
2212             if (!is_array($field)) {
2213                 continue;
2214             }
2215             $f = new StdClass();
2216             foreach ($field['#'] as $param => $value) {
2217                 if (!is_array($value)) {
2218                     continue;
2219                 }
2220                 $f->$param = $value[0]['#'];
2221             }
2222             $f->dataid = $this->module->id;
2223             $f->type = clean_param($f->type, PARAM_ALPHA);
2224             $result->importfields[] = $f;
2225         }
2226         /* Now add the HTML templates to the settings array so we can update d */
2227         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2228         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2229         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2230         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2231         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2232         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2233         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2234         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2235         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2236         $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2238         $result->settings->instance = $this->module->id;
2239         return $result;
2240     }
2242     /**
2243      * Import the preset into the given database module
2244      * @return bool
2245      */
2246     function import($overwritesettings) {
2247         global $DB, $CFG;
2249         $params = $this->get_preset_settings();
2250         $settings = $params->settings;
2251         $newfields = $params->importfields;
2252         $currentfields = $params->currentfields;
2253         $preservedfields = array();
2255         /* Maps fields and makes new ones */
2256         if (!empty($newfields)) {
2257             /* We require an injective mapping, and need to know what to protect */
2258             foreach ($newfields as $nid => $newfield) {
2259                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2260                 if ($cid == -1) {
2261                     continue;
2262                 }
2263                 if (array_key_exists($cid, $preservedfields)){
2264                     print_error('notinjectivemap', 'data');
2265                 }
2266                 else $preservedfields[$cid] = true;
2267             }
2269             foreach ($newfields as $nid => $newfield) {
2270                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2272                 /* A mapping. Just need to change field params. Data kept. */
2273                 if ($cid != -1 and isset($currentfields[$cid])) {
2274                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2275                     foreach ($newfield as $param => $value) {
2276                         if ($param != "id") {
2277                             $fieldobject->field->$param = $value;
2278                         }
2279                     }
2280                     unset($fieldobject->field->similarfield);
2281                     $fieldobject->update_field();
2282                     unset($fieldobject);
2283                 } else {
2284                     /* Make a new field */
2285                     include_once("field/$newfield->type/field.class.php");
2287                     if (!isset($newfield->description)) {
2288                         $newfield->description = '';
2289                     }
2290                     $classname = 'data_field_'.$newfield->type;
2291                     $fieldclass = new $classname($newfield, $this->module);
2292                     $fieldclass->insert_field();
2293                     unset($fieldclass);
2294                 }
2295             }
2296         }
2298         /* Get rid of all old unused data */
2299         if (!empty($preservedfields)) {
2300             foreach ($currentfields as $cid => $currentfield) {
2301                 if (!array_key_exists($cid, $preservedfields)) {
2302                     /* Data not used anymore so wipe! */
2303                     print "Deleting field $currentfield->name<br />";
2305                     $id = $currentfield->id;
2306                     //Why delete existing data records and related comments/ratings??
2307                     $DB->delete_records('data_content', array('fieldid'=>$id));
2308                     $DB->delete_records('data_fields', array('id'=>$id));
2309                 }
2310             }
2311         }
2313         // handle special settings here
2314         if (!empty($settings->defaultsort)) {
2315             if (is_numeric($settings->defaultsort)) {
2316                 // old broken value
2317                 $settings->defaultsort = 0;
2318             } else {
2319                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2320             }
2321         } else {
2322             $settings->defaultsort = 0;
2323         }
2325         // do we want to overwrite all current database settings?
2326         if ($overwritesettings) {
2327             // all supported settings
2328             $overwrite = array_keys((array)$settings);
2329         } else {
2330             // only templates and sorting
2331             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2332                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2333                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2334         }
2336         // now overwrite current data settings
2337         foreach ($this->module as $prop=>$unused) {
2338             if (in_array($prop, $overwrite)) {
2339                 $this->module->$prop = $settings->$prop;
2340             }
2341         }
2343         data_update_instance($this->module);
2345         return $this->cleanup();
2346     }
2348     /**
2349      * Any clean up routines should go here
2350      * @return bool
2351      */
2352     public function cleanup() {
2353         return true;
2354     }
2357 /**
2358  * Data preset importer for uploaded presets
2359  */
2360 class data_preset_upload_importer extends data_preset_importer {
2361     public function __construct($course, $cm, $module, $filepath) {
2362         global $USER;
2363         if (is_file($filepath)) {
2364             $fp = get_file_packer();
2365             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2366                 fulldelete($filepath);
2367             }
2368             $filepath .= '_extracted';
2369         }
2370         parent::__construct($course, $cm, $module, $filepath);
2371     }
2372     public function cleanup() {
2373         return fulldelete($this->directory);
2374     }
2377 /**
2378  * Data preset importer for existing presets
2379  */
2380 class data_preset_existing_importer extends data_preset_importer {
2381     protected $userid;
2382     public function __construct($course, $cm, $module, $fullname) {
2383         global $USER;
2384         list($userid, $shortname) = explode('/', $fullname, 2);
2385         $context = context_module::instance($cm->id);
2386         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2387            throw new coding_exception('Invalid preset provided');
2388         }
2390         $this->userid = $userid;
2391         $filepath = data_preset_path($course, $userid, $shortname);
2392         parent::__construct($course, $cm, $module, $filepath);
2393     }
2394     public function get_userid() {
2395         return $this->userid;
2396     }
2399 /**
2400  * @global object
2401  * @global object
2402  * @param object $course
2403  * @param int $userid
2404  * @param string $shortname
2405  * @return string
2406  */
2407 function data_preset_path($course, $userid, $shortname) {
2408     global $USER, $CFG;
2410     $context = context_course::instance($course->id);
2412     $userid = (int)$userid;
2414     $path = null;
2415     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2416         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2417     } else if ($userid == 0) {
2418         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2419     } else if ($userid < 0) {
2420         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2421     }
2423     return $path;
2426 /**
2427  * Implementation of the function for printing the form elements that control
2428  * whether the course reset functionality affects the data.
2429  *
2430  * @param $mform form passed by reference
2431  */
2432 function data_reset_course_form_definition(&$mform) {
2433     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2434     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2436     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2437     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2439     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2440     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2442     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2443     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2446 /**
2447  * Course reset form defaults.
2448  * @return array
2449  */
2450 function data_reset_course_form_defaults($course) {
2451     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2454 /**
2455  * Removes all grades from gradebook
2456  *
2457  * @global object
2458  * @global object
2459  * @param int $courseid
2460  * @param string $type optional type
2461  */
2462 function data_reset_gradebook($courseid, $type='') {
2463     global $CFG, $DB;
2465     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2466               FROM {data} d, {course_modules} cm, {modules} m
2467              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2469     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2470         foreach ($datas as $data) {
2471             data_grade_item_update($data, 'reset');
2472         }
2473     }
2476 /**
2477  * Actual implementation of the reset course functionality, delete all the
2478  * data responses for course $data->courseid.
2479  *
2480  * @global object
2481  * @global object
2482  * @param object $data the data submitted from the reset course.
2483  * @return array status array
2484  */
2485 function data_reset_userdata($data) {
2486     global $CFG, $DB;
2487     require_once($CFG->libdir.'/filelib.php');
2488     require_once($CFG->dirroot.'/rating/lib.php');
2490     $componentstr = get_string('modulenameplural', 'data');
2491     $status = array();
2493     $allrecordssql = "SELECT r.id
2494                         FROM {data_records} r
2495                              INNER JOIN {data} d ON r.dataid = d.id
2496                        WHERE d.course = ?";
2498     $alldatassql = "SELECT d.id
2499                       FROM {data} d
2500                      WHERE d.course=?";
2502     $rm = new rating_manager();
2503     $ratingdeloptions = new stdClass;
2504     $ratingdeloptions->component = 'mod_data';
2505     $ratingdeloptions->ratingarea = 'entry';
2507     // delete entries if requested
2508     if (!empty($data->reset_data)) {
2509         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2510         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2511         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2513         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2514             foreach ($datas as $dataid=>$unused) {
2515                 fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$dataid");
2517                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2518                     continue;
2519                 }
2520                 $datacontext = context_module::instance($cm->id);
2522                 $ratingdeloptions->contextid = $datacontext->id;
2523                 $rm->delete_ratings($ratingdeloptions);
2524             }
2525         }
2527         if (empty($data->reset_gradebook_grades)) {
2528             // remove all grades from gradebook
2529             data_reset_gradebook($data->courseid);
2530         }
2531         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2532     }
2534     // remove entries by users not enrolled into course
2535     if (!empty($data->reset_data_notenrolled)) {
2536         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2537                          FROM {data_records} r
2538                               JOIN {data} d ON r.dataid = d.id
2539                               LEFT JOIN {user} u ON r.userid = u.id
2540                         WHERE d.course = ? AND r.userid > 0";
2542         $course_context = context_course::instance($data->courseid);
2543         $notenrolled = array();
2544         $fields = array();
2545         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2546         foreach ($rs as $record) {
2547             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2548               or !is_enrolled($course_context, $record->userid)) {
2549                 //delete ratings
2550                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2551                     continue;
2552                 }
2553                 $datacontext = context_module::instance($cm->id);
2554                 $ratingdeloptions->contextid = $datacontext->id;
2555                 $ratingdeloptions->itemid = $record->id;
2556                 $rm->delete_ratings($ratingdeloptions);
2558                 $DB->delete_records('comments', array('itemid'=>$record->id, 'commentarea'=>'database_entry'));
2559                 $DB->delete_records('data_content', array('recordid'=>$record->id));
2560                 $DB->delete_records('data_records', array('id'=>$record->id));
2561                 // HACK: this is ugly - the recordid should be before the fieldid!
2562                 if (!array_key_exists($record->dataid, $fields)) {
2563                     if ($fs = $DB->get_records('data_fields', array('dataid'=>$record->dataid))) {
2564                         $fields[$record->dataid] = array_keys($fs);
2565                     } else {
2566                         $fields[$record->dataid] = array();
2567                     }
2568                 }
2569                 foreach($fields[$record->dataid] as $fieldid) {
2570                     fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$record->dataid/$fieldid/$record->id");
2571                 }
2572                 $notenrolled[$record->userid] = true;
2573             }
2574         }
2575         $rs->close();
2576         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2577     }
2579     // remove all ratings
2580     if (!empty($data->reset_data_ratings)) {
2581         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2582             foreach ($datas as $dataid=>$unused) {
2583                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2584                     continue;
2585                 }
2586                 $datacontext = context_module::instance($cm->id);
2588                 $ratingdeloptions->contextid = $datacontext->id;
2589                 $rm->delete_ratings($ratingdeloptions);
2590             }
2591         }
2593         if (empty($data->reset_gradebook_grades)) {
2594             // remove all grades from gradebook
2595             data_reset_gradebook($data->courseid);
2596         }
2598         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2599     }
2601     // remove all comments
2602     if (!empty($data->reset_data_comments)) {
2603         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2604         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2605     }
2607     // updating dates - shift may be negative too
2608     if ($data->timeshift) {
2609         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2610         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2611     }
2613     return $status;
2616 /**
2617  * Returns all other caps used in module
2618  *
2619  * @return array
2620  */
2621 function data_get_extra_capabilities() {
2622     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');
2625 /**
2626  * @param string $feature FEATURE_xx constant for requested feature
2627  * @return mixed True if module supports feature, null if doesn't know
2628  */
2629 function data_supports($feature) {
2630     switch($feature) {
2631         case FEATURE_GROUPS:                  return true;
2632         case FEATURE_GROUPINGS:               return true;
2633         case FEATURE_GROUPMEMBERSONLY:        return true;
2634         case FEATURE_MOD_INTRO:               return true;
2635         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2636         case FEATURE_GRADE_HAS_GRADE:         return true;
2637         case FEATURE_GRADE_OUTCOMES:          return true;
2638         case FEATURE_RATE:                    return true;
2639         case FEATURE_BACKUP_MOODLE2:          return true;
2640         case FEATURE_SHOW_DESCRIPTION:        return true;
2642         default: return null;
2643     }
2645 /**
2646  * @global object
2647  * @param array $export
2648  * @param string $delimiter_name
2649  * @param object $database
2650  * @param int $count
2651  * @param bool $return
2652  * @return string|void
2653  */
2654 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
2655     global $CFG;
2656     require_once($CFG->libdir . '/csvlib.class.php');
2658     $filename = $database . '-' . $count . '-record';
2659     if ($count > 1) {
2660         $filename .= 's';
2661     }
2662     if ($return) {
2663         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
2664     } else {
2665         csv_export_writer::download_array($filename, $export, $delimiter_name);
2666     }
2669 /**
2670  * @global object
2671  * @param array $export
2672  * @param string $dataname
2673  * @param int $count
2674  * @return string
2675  */
2676 function data_export_xls($export, $dataname, $count) {
2677     global $CFG;
2678     require_once("$CFG->libdir/excellib.class.php");
2679     $filename = clean_filename("{$dataname}-{$count}_record");
2680     if ($count > 1) {
2681         $filename .= 's';
2682     }
2683     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2684     $filename .= '.xls';
2686     $filearg = '-';
2687     $workbook = new MoodleExcelWorkbook($filearg);
2688     $workbook->send($filename);
2689     $worksheet = array();
2690     $worksheet[0] = $workbook->add_worksheet('');
2691     $rowno = 0;
2692     foreach ($export as $row) {
2693         $colno = 0;
2694         foreach($row as $col) {
2695             $worksheet[0]->write($rowno, $colno, $col);
2696             $colno++;
2697         }
2698         $rowno++;
2699     }
2700     $workbook->close();
2701     return $filename;
2704 /**
2705  * @global object
2706  * @param array $export
2707  * @param string $dataname
2708  * @param int $count
2709  * @param string
2710  */
2711 function data_export_ods($export, $dataname, $count) {
2712     global $CFG;
2713     require_once("$CFG->libdir/odslib.class.php");
2714     $filename = clean_filename("{$dataname}-{$count}_record");
2715     if ($count > 1) {
2716         $filename .= 's';
2717     }
2718     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2719     $filename .= '.ods';
2720     $filearg = '-';
2721     $workbook = new MoodleODSWorkbook($filearg);
2722     $workbook->send($filename);
2723     $worksheet = array();
2724     $worksheet[0] = $workbook->add_worksheet('');
2725     $rowno = 0;
2726     foreach ($export as $row) {
2727         $colno = 0;
2728         foreach($row as $col) {
2729             $worksheet[0]->write($rowno, $colno, $col);
2730             $colno++;
2731         }
2732         $rowno++;
2733     }
2734     $workbook->close();
2735     return $filename;
2738 /**
2739  * @global object
2740  * @param int $dataid
2741  * @param array $fields
2742  * @param array $selectedfields
2743  * @param int $currentgroup group ID of the current group. This is used for
2744  * exporting data while maintaining group divisions.
2745  * @param object $context the context in which the operation is performed (for capability checks)
2746  * @param bool $userdetails whether to include the details of the record author
2747  * @param bool $time whether to include time created/modified
2748  * @param bool $approval whether to include approval status
2749  * @return array
2750  */
2751 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
2752                              $userdetails=false, $time=false, $approval=false) {
2753     global $DB;
2755     if (is_null($context)) {
2756         $context = context_system::instance();
2757     }
2758     // exporting user data needs special permission
2759     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
2761     $exportdata = array();
2763     // populate the header in first row of export
2764     foreach($fields as $key => $field) {
2765         if (!in_array($field->field->id, $selectedfields)) {
2766             // ignore values we aren't exporting
2767             unset($fields[$key]);
2768         } else {
2769             $exportdata[0][] = $field->field->name;
2770         }
2771     }
2772     if ($userdetails) {
2773         $exportdata[0][] = get_string('user');
2774         $exportdata[0][] = get_string('username');
2775         $exportdata[0][] = get_string('email');
2776     }
2777     if ($time) {
2778         $exportdata[0][] = get_string('timeadded', 'data');
2779         $exportdata[0][] = get_string('timemodified', 'data');
2780     }
2781     if ($approval) {
2782         $exportdata[0][] = get_string('approved', 'data');
2783     }
2785     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2786     ksort($datarecords);
2787     $line = 1;
2788     foreach($datarecords as $record) {
2789         // get content indexed by fieldid
2790         if ($currentgroup) {
2791             $select = 'SELECT c.fieldid, c.content, c.content1, c.content2, c.content3, c.content4 FROM {data_content} c, {data_records} r WHERE c.recordid = ? AND r.id = c.recordid AND r.groupid = ?';
2792             $where = array($record->id, $currentgroup);
2793         } else {
2794             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
2795             $where = array($record->id);
2796         }
2798         if( $content = $DB->get_records_sql($select, $where) ) {
2799             foreach($fields as $field) {
2800                 $contents = '';
2801                 if(isset($content[$field->field->id])) {
2802                     $contents = $field->export_text_value($content[$field->field->id]);
2803                 }
2804                 $exportdata[$line][] = $contents;
2805             }
2806             if ($userdetails) { // Add user details to the export data
2807                 $userdata = get_complete_user_data('id', $record->userid);
2808                 $exportdata[$line][] = fullname($userdata);
2809                 $exportdata[$line][] = $userdata->username;
2810                 $exportdata[$line][] = $userdata->email;
2811             }
2812             if ($time) { // Add time added / modified
2813                 $exportdata[$line][] = userdate($record->timecreated);
2814                 $exportdata[$line][] = userdate($record->timemodified);
2815             }
2816             if ($approval) { // Add approval status
2817                 $exportdata[$line][] = (int) $record->approved;
2818             }
2819         }
2820         $line++;
2821     }
2822     $line--;
2823     return $exportdata;
2826 ////////////////////////////////////////////////////////////////////////////////
2827 // File API                                                                   //
2828 ////////////////////////////////////////////////////////////////////////////////
2830 /**
2831  * Lists all browsable file areas
2832  *
2833  * @package  mod_data
2834  * @category files
2835  * @param stdClass $course course object
2836  * @param stdClass $cm course module object
2837  * @param stdClass $context context object
2838  * @return array
2839  */
2840 function data_get_file_areas($course, $cm, $context) {
2841     return array('content' => get_string('areacontent', 'mod_data'));
2844 /**
2845  * File browsing support for data module.
2846  *
2847  * @param file_browser $browser
2848  * @param array $areas
2849  * @param stdClass $course
2850  * @param cm_info $cm
2851  * @param context $context
2852  * @param string $filearea
2853  * @param int $itemid
2854  * @param string $filepath
2855  * @param string $filename
2856  * @return file_info_stored file_info_stored instance or null if not found
2857  */
2858 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
2859     global $CFG, $DB, $USER;
2861     if ($context->contextlevel != CONTEXT_MODULE) {
2862         return null;
2863     }
2865     if (!isset($areas[$filearea])) {
2866         return null;
2867     }
2869     if (is_null($itemid)) {
2870         require_once($CFG->dirroot.'/mod/data/locallib.php');
2871         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
2872     }
2874     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
2875         return null;
2876     }
2878     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2879         return null;
2880     }
2882     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2883         return null;
2884     }
2886     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2887         return null;
2888     }
2890     //check if approved
2891     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2892         return null;
2893     }
2895     // group access
2896     if ($record->groupid) {
2897         $groupmode = groups_get_activity_groupmode($cm, $course);
2898         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2899             if (!groups_is_member($record->groupid)) {
2900                 return null;
2901             }
2902         }
2903     }
2905     $fieldobj = data_get_field($field, $data, $cm);
2907     $filepath = is_null($filepath) ? '/' : $filepath;
2908     $filename = is_null($filename) ? '.' : $filename;
2909     if (!$fieldobj->file_ok($filepath.$filename)) {
2910         return null;
2911     }
2913     $fs = get_file_storage();
2914     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
2915         return null;
2916     }
2918     // Checks to see if the user can manage files or is the owner.
2919     // TODO MDL-33805 - Do not use userid here and move the capability check above.
2920     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
2921         return null;
2922     }
2924     $urlbase = $CFG->wwwroot.'/pluginfile.php';
2926     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
2929 /**
2930  * Serves the data attachments. Implements needed access control ;-)
2931  *
2932  * @package  mod_data
2933  * @category files
2934  * @param stdClass $course course object
2935  * @param stdClass $cm course module object
2936  * @param stdClass $context context object
2937  * @param string $filearea file area
2938  * @param array $args extra arguments
2939  * @param bool $forcedownload whether or not force download
2940  * @param array $options additional options affecting the file serving
2941  * @return bool false if file not found, does not return if found - justsend the file
2942  */
2943 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
2944     global $CFG, $DB;
2946     if ($context->contextlevel != CONTEXT_MODULE) {
2947         return false;
2948     }
2950     require_course_login($course, true, $cm);
2952     if ($filearea === 'content') {
2953         $contentid = (int)array_shift($args);
2955         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
2956             return false;
2957         }
2959         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2960             return false;
2961         }
2963         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2964             return false;
2965         }
2967         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2968             return false;
2969         }
2971         if ($data->id != $cm->instance) {
2972             // hacker attempt - context does not match the contentid
2973             return false;
2974         }
2976         //check if approved
2977         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2978             return false;
2979         }
2981         // group access
2982         if ($record->groupid) {
2983             $groupmode = groups_get_activity_groupmode($cm, $course);
2984             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2985                 if (!groups_is_member($record->groupid)) {
2986                     return false;
2987                 }
2988             }
2989         }
2991         $fieldobj = data_get_field($field, $data, $cm);
2993         $relativepath = implode('/', $args);
2994         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
2996         if (!$fieldobj->file_ok($relativepath)) {
2997             return false;
2998         }
3000         $fs = get_file_storage();
3001         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3002             return false;
3003         }
3005         // finally send the file
3006         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
3007     }
3009     return false;
3013 function data_extend_navigation($navigation, $course, $module, $cm) {
3014     global $CFG, $OUTPUT, $USER, $DB;
3016     $rid = optional_param('rid', 0, PARAM_INT);
3018     $data = $DB->get_record('data', array('id'=>$cm->instance));
3019     $currentgroup = groups_get_activity_group($cm);
3020     $groupmode = groups_get_activity_groupmode($cm);
3022      $numentries = data_numentries($data);
3023     /// Check the number of entries required against the number of entries already made (doesn't apply to teachers)
3024     if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !has_capability('mod/data:manageentries', context_module::instance($cm->id))) {
3025         $data->entriesleft = $data->requiredentries - $numentries;
3026         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3027         $entriesnode->add_class('note');
3028     }
3030     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3031     if (!empty($rid)) {
3032         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3033     } else {
3034         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3035     }
3036     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3039 /**
3040  * Adds module specific settings to the settings block
3041  *
3042  * @param settings_navigation $settings The settings navigation object
3043  * @param navigation_node $datanode The node to add module settings to
3044  */
3045 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3046     global $PAGE, $DB, $CFG, $USER;
3048     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3050     $currentgroup = groups_get_activity_group($PAGE->cm);
3051     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3053     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3054         if (empty($editentry)) { //TODO: undefined
3055             $addstring = get_string('add', 'data');
3056         } else {
3057             $addstring = get_string('editentry', 'data');
3058         }
3059         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3060     }
3062     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3063         // The capability required to Export database records is centrally defined in 'lib.php'
3064         // and should be weaker than those required to edit Templates, Fields and Presets.
3065         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3066     }
3067     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3068         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3069     }
3071     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3072         $currenttab = '';
3073         if ($currenttab == 'list') {
3074             $defaultemplate = 'listtemplate';
3075         } else if ($currenttab == 'add') {
3076             $defaultemplate = 'addtemplate';
3077         } else if ($currenttab == 'asearch') {
3078             $defaultemplate = 'asearchtemplate';
3079         } else {
3080             $defaultemplate = 'singletemplate';
3081         }
3083         $templates = $datanode->add(get_string('templates', 'data'));
3085         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3086         foreach ($templatelist as $template) {
3087             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3088         }
3090         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3091         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3092     }
3094     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3095         require_once("$CFG->libdir/rsslib.php");
3097         $string = get_string('rsstype','forum');
3099         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3100         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3101     }
3104 /**
3105  * Save the database configuration as a preset.
3106  *
3107  * @param stdClass $course The course the database module belongs to.
3108  * @param stdClass $cm The course module record
3109  * @param stdClass $data The database record
3110  * @param string $path
3111  * @return bool
3112  */
3113 function data_presets_save($course, $cm, $data, $path) {
3114     global $USER;
3115     $fs = get_file_storage();
3116     $filerecord = new stdClass;
3117     $filerecord->contextid = DATA_PRESET_CONTEXT;
3118     $filerecord->component = DATA_PRESET_COMPONENT;
3119     $filerecord->filearea = DATA_PRESET_FILEAREA;
3120     $filerecord->itemid = 0;
3121     $filerecord->filepath = '/'.$path.'/';
3122     $filerecord->userid = $USER->id;
3124     $filerecord->filename = 'preset.xml';
3125     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3127     $filerecord->filename = 'singletemplate.html';
3128     $fs->create_file_from_string($filerecord, $data->singletemplate);
3130     $filerecord->filename = 'listtemplateheader.html';
3131     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3133     $filerecord->filename = 'listtemplate.html';
3134     $fs->create_file_from_string($filerecord, $data->listtemplate);
3136     $filerecord->filename = 'listtemplatefooter.html';
3137     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3139     $filerecord->filename = 'addtemplate.html';
3140     $fs->create_file_from_string($filerecord, $data->addtemplate);
3142     $filerecord->filename = 'rsstemplate.html';
3143     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3145     $filerecord->filename = 'rsstitletemplate.html';
3146     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3148     $filerecord->filename = 'csstemplate.css';
3149     $fs->create_file_from_string($filerecord, $data->csstemplate);
3151     $filerecord->filename = 'jstemplate.js';
3152     $fs->create_file_from_string($filerecord, $data->jstemplate);
3154     $filerecord->filename = 'asearchtemplate.html';
3155     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3157     return true;
3160 /**
3161  * Generates the XML for the database module provided
3162  *
3163  * @global moodle_database $DB
3164  * @param stdClass $course The course the database module belongs to.
3165  * @param stdClass $cm The course module record
3166  * @param stdClass $data The database record
3167  * @return string The XML for the preset
3168  */
3169 function data_presets_generate_xml($course, $cm, $data) {
3170     global $DB;
3172     // Assemble "preset.xml":
3173     $presetxmldata = "<preset>\n\n";
3175     // Raw settings are not preprocessed during saving of presets
3176     $raw_settings = array(
3177         'intro',
3178         'comments',
3179         'requiredentries',
3180         'requiredentriestoview',
3181         'maxentries',
3182         'rssarticles',
3183         'approval',
3184         'defaultsortdir'
3185     );
3187     $presetxmldata .= "<settings>\n";
3188     // First, settings that do not require any conversion
3189     foreach ($raw_settings as $setting) {
3190         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3191     }
3193     // Now specific settings
3194     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3195         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3196     } else {
3197         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3198     }
3199     $presetxmldata .= "</settings>\n\n";
3200     // Now for the fields. Grab all that are non-empty
3201     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3202     ksort($fields);
3203     if (!empty($fields)) {
3204         foreach ($fields as $field) {
3205             $presetxmldata .= "<field>\n";
3206             foreach ($field as $key => $value) {
3207                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3208                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3209                 }
3210             }
3211             $presetxmldata .= "</field>\n\n";
3212         }
3213     }
3214     $presetxmldata .= '</preset>';
3215     return $presetxmldata;
3218 function data_presets_export($course, $cm, $data, $tostorage=false) {
3219     global $CFG, $DB;
3221     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3222     $exportsubdir = "mod_data/presetexport/$presetname";
3223     make_temp_directory($exportsubdir);
3224     $exportdir = "$CFG->tempdir/$exportsubdir";
3226     // Assemble "preset.xml":
3227     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3229     // After opening a file in write mode, close it asap
3230     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3231     fwrite($presetxmlfile, $presetxmldata);
3232     fclose($presetxmlfile);
3234     // Now write the template files
3235     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3236     fwrite($singletemplate, $data->singletemplate);
3237     fclose($singletemplate);
3239     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3240     fwrite($listtemplateheader, $data->listtemplateheader);
3241     fclose($listtemplateheader);
3243     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3244     fwrite($listtemplate, $data->listtemplate);
3245     fclose($listtemplate);
3247     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3248     fwrite($listtemplatefooter, $data->listtemplatefooter);
3249     fclose($listtemplatefooter);
3251     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3252     fwrite($addtemplate, $data->addtemplate);
3253     fclose($addtemplate);
3255     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3256     fwrite($rsstemplate, $data->rsstemplate);
3257     fclose($rsstemplate);
3259     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3260     fwrite($rsstitletemplate, $data->rsstitletemplate);
3261     fclose($rsstitletemplate);
3263     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3264     fwrite($csstemplate, $data->csstemplate);
3265     fclose($csstemplate);
3267     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3268     fwrite($jstemplate, $data->jstemplate);
3269     fclose($jstemplate);
3271     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3272     fwrite($asearchtemplate, $data->asearchtemplate);
3273     fclose($asearchtemplate);
3275     // Check if all files have been generated
3276     if (! is_directory_a_preset($exportdir)) {
3277         print_error('generateerror', 'data');
3278     }
3280     $filenames = array(
3281         'preset.xml',
3282         'singletemplate.html',
3283         'listtemplateheader.html',
3284         'listtemplate.html',
3285         'listtemplatefooter.html',
3286         'addtemplate.html',
3287         'rsstemplate.html',
3288         'rsstitletemplate.html',
3289         'csstemplate.css',
3290         'jstemplate.js',
3291         'asearchtemplate.html'
3292     );
3294     $filelist = array();
3295     foreach ($filenames as $filename) {
3296         $filelist[$filename] = $exportdir . '/' . $filename;
3297     }
3299     $exportfile = $exportdir.'.zip';
3300     file_exists($exportfile) && unlink($exportfile);
3302     $fp = get_file_packer('application/zip');
3303     $fp->archive_to_pathname($filelist, $exportfile);
3305     foreach ($filelist as $file) {
3306         unlink($file);
3307     }
3308     rmdir($exportdir);
3310     // Return the full path to the exported preset file:
3311     return $exportfile;
3314 /**
3315  * Running addtional permission check on plugin, for example, plugins
3316  * may have switch to turn on/off comments option, this callback will
3317  * affect UI display, not like pluginname_comment_validate only throw
3318  * exceptions.
3319  * Capability check has been done in comment->check_permissions(), we
3320  * don't need to do it again here.
3321  *
3322  * @package  mod_data
3323  * @category comment
3324  *
3325  * @param stdClass $comment_param {
3326  *              context  => context the context object
3327  *              courseid => int course id
3328  *              cm       => stdClass course module object
3329  *              commentarea => string comment area
3330  *              itemid      => int itemid
3331  * }
3332  * @return array
3333  */
3334 function data_comment_permissions($comment_param) {
3335     global $CFG, $DB;
3336     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3337         throw new comment_exception('invalidcommentitemid');
3338     }
3339     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3340         throw new comment_exception('invalidid', 'data');
3341     }
3342     if ($data->comments) {
3343         return array('post'=>true, 'view'=>true);
3344     } else {
3345         return array('post'=>false, 'view'=>false);
3346     }
3349 /**
3350  * Validate comment parameter before perform other comments actions
3351  *
3352  * @package  mod_data
3353  * @category comment
3354  *
3355  * @param stdClass $comment_param {
3356  *              context  => context the context object
3357  *              courseid => int course id
3358  *              cm       => stdClass course module object
3359  *              commentarea => string comment area
3360  *              itemid      => int itemid
3361  * }
3362  * @return boolean
3363  */
3364 function data_comment_validate($comment_param) {
3365     global $DB;
3366     // validate comment area
3367     if ($comment_param->commentarea != 'database_entry') {
3368         throw new comment_exception('invalidcommentarea');
3369     }
3370     // validate itemid
3371     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3372         throw new comment_exception('invalidcommentitemid');
3373     }
3374     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3375         throw new comment_exception('invalidid', 'data');
3376     }
3377     if (!$course = $DB->get_record('course', array('id'=>$data->course))) {
3378         throw new comment_exception('coursemisconf');
3379     }
3380     if (!$cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
3381         throw new comment_exception('invalidcoursemodule');
3382     }
3383     if (!$data->comments) {
3384         throw new comment_exception('commentsoff', 'data');
3385     }
3386     $context = context_module::instance($cm->id);
3388     //check if approved
3389     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3390         throw new comment_exception('notapproved', 'data');
3391     }
3393     // group access
3394     if ($record->groupid) {
3395         $groupmode = groups_get_activity_groupmode($cm, $course);
3396         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3397             if (!groups_is_member($record->groupid)) {
3398                 throw new comment_exception('notmemberofgroup');
3399             }
3400         }
3401     }
3402     // validate context id
3403     if ($context->id != $comment_param->context->id) {
3404         throw new comment_exception('invalidcontext');
3405     }
3406     // validation for comment deletion
3407     if (!empty($comment_param->commentid)) {
3408         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3409             if ($comment->commentarea != 'database_entry') {
3410                 throw new comment_exception('invalidcommentarea');
3411             }
3412             if ($comment->contextid != $comment_param->context->id) {
3413                 throw new comment_exception('invalidcontext');
3414             }
3415             if ($comment->itemid != $comment_param->itemid) {
3416                 throw new comment_exception('invalidcommentitemid');
3417             }
3418         } else {
3419             throw new comment_exception('invalidcommentid');
3420         }
3421     }
3422     return true;
3425 /**
3426  * Return a list of page types
3427  * @param string $pagetype current page type
3428  * @param stdClass $parentcontext Block's parent context
3429  * @param stdClass $currentcontext Current context of block
3430  */
3431 function data_page_type_list($pagetype, $parentcontext, $currentcontext) {
3432     $module_pagetype = array('mod-data-*'=>get_string('page-mod-data-x', 'data'));
3433     return $module_pagetype;
3436 /**
3437  * Get all of the record ids from a database activity.
3438  *
3439  * @param int    $dataid      The dataid of the database module.
3440  * @param object $selectdata  Contains an additional sql statement for the
3441  *                            where clause for group and approval fields.
3442  * @param array  $params      Parameters that coincide with the sql statement.
3443  * @return array $idarray     An array of record ids
3444  */
3445 function data_get_all_recordids($dataid, $selectdata = '', $params = null) {
3446     global $DB;
3447     $initsql = 'SELECT r.id
3448                   FROM {data_records} r
3449                  WHERE r.dataid = :dataid';
3450     if ($selectdata != '') {
3451         $initsql .= $selectdata;
3452         $params = array_merge(array('dataid' => $dataid), $params);
3453     } else {
3454         $params = array('dataid' => $dataid);
3455     }
3456     $initsql .= ' GROUP BY r.id';
3457     $initrecord = $DB->get_recordset_sql($initsql, $params);
3458     $idarray = array();
3459     foreach ($initrecord as $data) {
3460         $idarray[] = $data->id;
3461     }
3462     // Close the record set and free up resources.
3463     $initrecord->close();
3464     return $idarray;
3467 /**
3468  * Get the ids of all the records that match that advanced search criteria
3469  * This goes and loops through each criterion one at a time until it either
3470  * runs out of records or returns a subset of records.
3471  *
3472  * @param array $recordids    An array of record ids.
3473  * @param array $searcharray  Contains information for the advanced search criteria
3474  * @param int $dataid         The data id of the database.
3475  * @return array $recordids   An array of record ids.
3476  */
3477 function data_get_advance_search_ids($recordids, $searcharray, $dataid) {
3478     $searchcriteria = array_keys($searcharray);
3479     // Loop through and reduce the IDs one search criteria at a time.
3480     foreach ($searchcriteria as $key) {
3481         $recordids = data_get_recordids($key, $searcharray, $dataid, $recordids);
3482         // If we don't have anymore IDs then stop.
3483         if (!$recordids) {
3484             break;
3485         }
3486     }
3487     return $recordids;
3490 /**
3491  * Gets the record IDs given the search criteria
3492  *
3493  * @param string $alias       Record alias.
3494  * @param array $searcharray  Criteria for the search.
3495  * @param int $dataid         Data ID for the database
3496  * @param array $recordids    An array of record IDs.
3497  * @return array $nestarray   An arry of record IDs
3498  */
3499 function data_get_recordids($alias, $searcharray, $dataid, $recordids) {
3500     global $DB;
3502     $nestsearch = $searcharray[$alias];
3503     // searching for content outside of mdl_data_content
3504     if ($alias < 0) {
3505         $alias = '';
3506     }
3507     list($insql, $params) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3508     $nestselect = 'SELECT c' . $alias . '.recordid
3509                      FROM {data_content} c' . $alias . ',
3510                           {data_fields} f,
3511                           {data_records} r,
3512                           {user} u ';
3513     $nestwhere = 'WHERE u.id = r.userid
3514                     AND f.id = c' . $alias . '.fieldid
3515                     AND r.id = c' . $alias . '.recordid
3516                     AND r.dataid = :dataid
3517                     AND c' . $alias .'.recordid ' . $insql . '
3518                     AND ';
3520     $params['dataid'] = $dataid;
3521     if (count($nestsearch->params) != 0) {
3522         $params = array_merge($params, $nestsearch->params);
3523         $nestsql = $nestselect . $nestwhere . $nestsearch->sql;
3524     } else {
3525         $thing = $DB->sql_like($nestsearch->field, ':search1', false);
3526         $nestsql = $nestselect . $nestwhere . $thing . ' GROUP BY c' . $alias . '.recordid';
3527         $params['search1'] = "%$nestsearch->data%";
3528     }
3529     $nestrecords = $DB->get_recordset_sql($nestsql, $params);
3530     $nestarray = array();
3531     foreach ($nestrecords as $data) {
3532         $nestarray[] = $data->recordid;
3533     }
3534     // Close the record set and free up resources.
3535     $nestrecords->close();
3536     return $nestarray;
3539 /**
3540  * Returns an array with an sql string for advanced searches and the parameters that go with them.
3541  *
3542  * @param int $sort            DATA_*
3543  * @param stdClass $data       Data module object
3544  * @param array $recordids     An array of record IDs.
3545  * @param string $selectdata   Information for the where and select part of the sql statement.
3546  * @param string $sortorder    Additional sort parameters
3547  * @return array sqlselect     sqlselect['sql'] has the sql string, sqlselect['params'] contains an array of parameters.
3548  */
3549 function data_get_advanced_search_sql($sort, $data, $recordids, $selectdata, $sortorder) {
3550     global $DB;
3551     if ($sort == 0) {
3552         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname
3553                         FROM {data_content} c,
3554                              {data_records} r,
3555                              {user} u ';
3556         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname ';
3557     } else {
3558         // Sorting through 'Other' criteria
3559         if ($sort <= 0) {
3560             switch ($sort) {
3561                 case DATA_LASTNAME:
3562                     $sortcontentfull = "u.lastname";
3563                     break;
3564                 case DATA_FIRSTNAME:
3565                     $sortcontentfull = "u.firstname";
3566                     break;
3567                 case DATA_APPROVED:
3568                     $sortcontentfull = "r.approved";
3569                     break;
3570                 case DATA_TIMEMODIFIED:
3571                     $sortcontentfull = "r.timemodified";
3572                     break;
3573                 case DATA_TIMEADDED:
3574                 default:
3575                     $sortcontentfull = "r.timecreated";
3576             }
3577         } else {
3578             $sortfield = data_get_field_from_id($sort, $data);
3579             $sortcontent = $DB->sql_compare_text('c.' . $sortfield->get_sort_field());
3580             $sortcontentfull = $sortfield->get_sort_sql($sortcontent);
3581         }
3583         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' . $sortcontentfull . '
3584                               AS sortorder
3585                             FROM {data_content} c,
3586                                  {data_records} r,
3587                                  {user} u ';
3588         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' .$sortcontentfull;
3589     }
3591     // Default to a standard Where statement if $selectdata is empty.
3592     if ($selectdata == '') {
3593         $selectdata = 'WHERE c.recordid = r.id
3594                          AND r.dataid = :dataid
3595                          AND r.userid = u.id ';
3596     }
3598     // Find the field we are sorting on
3599     if ($sort > 0 or data_get_field_from_id($sort, $data)) {
3600         $selectdata .= ' AND c.fieldid = :sort';
3601     }
3603     // If there are no record IDs then return an sql statment that will return no rows.
3604     if (count($recordids) != 0) {
3605         list($insql, $inparam) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3606     } else {
3607         list($insql, $inparam) = $DB->get_in_or_equal(array('-1'), SQL_PARAMS_NAMED);
3608     }
3609     $nestfromsql = $selectdata . ' AND c.recordid ' . $insql . $groupsql;
3610     $sqlselect['sql'] = "$nestselectsql $nestfromsql $sortorder";
3611     $sqlselect['params'] = $inparam;
3612     return $sqlselect;
3615 /**
3616  * Checks to see if the user has permission to delete the preset.
3617  * @param stdClass $context  Context object.
3618  * @param stdClass $preset  The preset object that we are checking for deletion.
3619  * @return bool  Returns true if the user can delete, otherwise false.
3620  */
3621 function data_user_can_delete_preset($context, $preset) {
3622     global $USER;
3624     if (has_capability('mod/data:manageuserpresets', $context)) {
3625         return true;
3626     } else {
3627         $candelete = false;
3628         if ($preset->userid == $USER->id) {
3629             $candelete = true;
3630         }
3631         return $candelete;
3632     }