54b28bfdb7eee080e9360fdfdb2d5424ae138882
[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             $replacement[] = '<span class="approve"><a href="'.$CFG->wwwroot.'/mod/data/view.php?d='.$data->id.'&amp;approve='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('i/approve') . '" class="iconsmall" alt="'.get_string('approve').'" /></a></span>';
1256         } else {
1257             $replacement[] = '';
1258         }
1260         $patterns[]='##comments##';
1261         if (($template == 'listtemplate') && ($data->comments)) {
1263             if (!empty($CFG->usecomments)) {
1264                 require_once($CFG->dirroot  . '/comment/lib.php');
1265                 list($context, $course, $cm) = get_context_info_array($context->id);
1266                 $cmt = new stdClass();
1267                 $cmt->context = $context;
1268                 $cmt->course  = $course;
1269                 $cmt->cm      = $cm;
1270                 $cmt->area    = 'database_entry';
1271                 $cmt->itemid  = $record->id;
1272                 $cmt->showcount = true;
1273                 $cmt->component = 'mod_data';
1274                 $comment = new comment($cmt);
1275                 $replacement[] = $comment->output(true);
1276             }
1277         } else {
1278             $replacement[] = '';
1279         }
1281         // actual replacement of the tags
1282         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1284         // no more html formatting and filtering - see MDL-6635
1285         if ($return) {
1286             return $newtext;
1287         } else {
1288             echo $newtext;
1290             // hack alert - return is always false in singletemplate anyway ;-)
1291             /**********************************
1292              *    Printing Ratings Form       *
1293              *********************************/
1294             if ($template == 'singletemplate') {    //prints ratings options
1295                 data_print_ratings($data, $record);
1296             }
1298             /**********************************
1299              *    Printing Comments Form       *
1300              *********************************/
1301             if (($template == 'singletemplate') && ($data->comments)) {
1302                 if (!empty($CFG->usecomments)) {
1303                     require_once($CFG->dirroot . '/comment/lib.php');
1304                     list($context, $course, $cm) = get_context_info_array($context->id);
1305                     $cmt = new stdClass();
1306                     $cmt->context = $context;
1307                     $cmt->course  = $course;
1308                     $cmt->cm      = $cm;
1309                     $cmt->area    = 'database_entry';
1310                     $cmt->itemid  = $record->id;
1311                     $cmt->showcount = true;
1312                     $cmt->component = 'mod_data';
1313                     $comment = new comment($cmt);
1314                     $comment->output(false);
1315                 }
1316             }
1317         }
1318     }
1321 /**
1322  * Return rating related permissions
1323  *
1324  * @param string $contextid the context id
1325  * @param string $component the component to get rating permissions for
1326  * @param string $ratingarea the rating area to get permissions for
1327  * @return array an associative array of the user's rating permissions
1328  */
1329 function data_rating_permissions($contextid, $component, $ratingarea) {
1330     $context = context::instance_by_id($contextid, MUST_EXIST);
1331     if ($component != 'mod_data' || $ratingarea != 'entry') {
1332         return null;
1333     }
1334     return array(
1335         'view'    => has_capability('mod/data:viewrating',$context),
1336         'viewany' => has_capability('mod/data:viewanyrating',$context),
1337         'viewall' => has_capability('mod/data:viewallratings',$context),
1338         'rate'    => has_capability('mod/data:rate',$context)
1339     );
1342 /**
1343  * Validates a submitted rating
1344  * @param array $params submitted data
1345  *            context => object the context in which the rated items exists [required]
1346  *            itemid => int the ID of the object being rated
1347  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1348  *            rating => int the submitted rating
1349  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1350  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1351  * @return boolean true if the rating is valid. Will throw rating_exception if not
1352  */
1353 function data_rating_validate($params) {
1354     global $DB, $USER;
1356     // Check the component is mod_data
1357     if ($params['component'] != 'mod_data') {
1358         throw new rating_exception('invalidcomponent');
1359     }
1361     // Check the ratingarea is entry (the only rating area in data module)
1362     if ($params['ratingarea'] != 'entry') {
1363         throw new rating_exception('invalidratingarea');
1364     }
1366     // Check the rateduserid is not the current user .. you can't rate your own entries
1367     if ($params['rateduserid'] == $USER->id) {
1368         throw new rating_exception('nopermissiontorate');
1369     }
1371     $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
1372                   FROM {data_records} r
1373                   JOIN {data} d ON r.dataid = d.id
1374                  WHERE r.id = :itemid";
1375     $dataparams = array('itemid'=>$params['itemid']);
1376     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1377         //item doesn't exist
1378         throw new rating_exception('invaliditemid');
1379     }
1381     if ($info->scale != $params['scaleid']) {
1382         //the scale being submitted doesnt match the one in the database
1383         throw new rating_exception('invalidscaleid');
1384     }
1386     //check that the submitted rating is valid for the scale
1388     // lower limit
1389     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1390         throw new rating_exception('invalidnum');
1391     }
1393     // upper limit
1394     if ($info->scale < 0) {
1395         //its a custom scale
1396         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1397         if ($scalerecord) {
1398             $scalearray = explode(',', $scalerecord->scale);
1399             if ($params['rating'] > count($scalearray)) {
1400                 throw new rating_exception('invalidnum');
1401             }
1402         } else {
1403             throw new rating_exception('invalidscaleid');
1404         }
1405     } else if ($params['rating'] > $info->scale) {
1406         //if its numeric and submitted rating is above maximum
1407         throw new rating_exception('invalidnum');
1408     }
1410     if ($info->approval && !$info->approved) {
1411         //database requires approval but this item isnt approved
1412         throw new rating_exception('nopermissiontorate');
1413     }
1415     // check the item we're rating was created in the assessable time window
1416     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1417         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1418             throw new rating_exception('notavailable');
1419         }
1420     }
1422     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1423     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1424     $context = context_module::instance($cm->id);
1426     // if the supplied context doesnt match the item's context
1427     if ($context->id != $params['context']->id) {
1428         throw new rating_exception('invalidcontext');
1429     }
1431     // Make sure groups allow this user to see the item they're rating
1432     $groupid = $info->groupid;
1433     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1434         if (!groups_group_exists($groupid)) { // Can't find group
1435             throw new rating_exception('cannotfindgroup');//something is wrong
1436         }
1438         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1439             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1440             throw new rating_exception('notmemberofgroup');
1441         }
1442     }
1444     return true;
1448 /**
1449  * function that takes in the current data, number of items per page,
1450  * a search string and prints a preference box in view.php
1451  *
1452  * This preference box prints a searchable advanced search template if
1453  *     a) A template is defined
1454  *  b) The advanced search checkbox is checked.
1455  *
1456  * @global object
1457  * @global object
1458  * @param object $data
1459  * @param int $perpage
1460  * @param string $search
1461  * @param string $sort
1462  * @param string $order
1463  * @param array $search_array
1464  * @param int $advanced
1465  * @param string $mode
1466  * @return void
1467  */
1468 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1469     global $CFG, $DB, $PAGE, $OUTPUT;
1471     $cm = get_coursemodule_from_instance('data', $data->id);
1472     $context = context_module::instance($cm->id);
1473     echo '<br /><div class="datapreferences">';
1474     echo '<form id="options" action="view.php" method="get">';
1475     echo '<div>';
1476     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1477     if ($mode =='asearch') {
1478         $advanced = 1;
1479         echo '<input type="hidden" name="mode" value="list" />';
1480     }
1481     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1482     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1483                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1484     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id'=>'pref_perpage'));
1486     if ($advanced) {
1487         $regsearchclass = 'search_none';
1488         $advancedsearchclass = 'search_inline';
1489     } else {
1490         $regsearchclass = 'search_inline';
1491         $advancedsearchclass = 'search_none';
1492     }
1493     echo '<div id="reg_search" class="' . $regsearchclass . '" >&nbsp;&nbsp;&nbsp;';
1494     echo '<label for="pref_search">'.get_string('search').'</label> <input type="text" size="16" name="search" id= "pref_search" value="'.s($search).'" /></div>';
1495     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1496     // foreach field, print the option
1497     echo '<select name="sort" id="pref_sortby">';
1498     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1499         echo '<optgroup label="'.get_string('fields', 'data').'">';
1500         foreach ($fields as $field) {
1501             if ($field->id == $sort) {
1502                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1503             } else {
1504                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1505             }
1506         }
1507         echo '</optgroup>';
1508     }
1509     $options = array();
1510     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1511     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1512     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1513     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1514     if ($data->approval and has_capability('mod/data:approve', $context)) {
1515         $options[DATA_APPROVED] = get_string('approved', 'data');
1516     }
1517     echo '<optgroup label="'.get_string('other', 'data').'">';
1518     foreach ($options as $key => $name) {
1519         if ($key == $sort) {
1520             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1521         } else {
1522             echo '<option value="'.$key.'">'.$name.'</option>';
1523         }
1524     }
1525     echo '</optgroup>';
1526     echo '</select>';
1527     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1528     echo '<select id="pref_order" name="order">';
1529     if ($order == 'ASC') {
1530         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1531     } else {
1532         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1533     }
1534     if ($order == 'DESC') {
1535         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1536     } else {
1537         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1538     }
1539     echo '</select>';
1541     if ($advanced) {
1542         $checked = ' checked="checked" ';
1543     }
1544     else {
1545         $checked = '';
1546     }
1547     $PAGE->requires->js('/mod/data/data.js');
1548     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1549     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1550     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1551     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1553     echo '<br />';
1554     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1555     echo '<table class="boxaligncenter">';
1557     // print ASC or DESC
1558     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1559     $i = 0;
1561     // Determine if we are printing all fields for advanced search, or the template for advanced search
1562     // If a template is not defined, use the deafault template and display all fields.
1563     if(empty($data->asearchtemplate)) {
1564         data_generate_default_template($data, 'asearchtemplate');
1565     }
1567     static $fields = NULL;
1568     static $isteacher;
1569     static $dataid = NULL;
1571     if (empty($dataid)) {
1572         $dataid = $data->id;
1573     } else if ($dataid != $data->id) {
1574         $fields = NULL;
1575     }
1577     if (empty($fields)) {
1578         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1579         foreach ($fieldrecords as $fieldrecord) {
1580             $fields[]= data_get_field($fieldrecord, $data);
1581         }
1583         $isteacher = has_capability('mod/data:managetemplates', $context);
1584     }
1586     // Replacing tags
1587     $patterns = array();
1588     $replacement = array();
1590     // Then we generate strings to replace for normal tags
1591     foreach ($fields as $field) {
1592         $fieldname = $field->field->name;
1593         $fieldname = preg_quote($fieldname, '/');
1594         $patterns[] = "/\[\[$fieldname\]\]/i";
1595         $searchfield = data_get_field_from_id($field->field->id, $data);
1596         if (!empty($search_array[$field->field->id]->data)) {
1597             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1598         } else {
1599             $replacement[] = $searchfield->display_search_field();
1600         }
1601     }
1602     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1603     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1604     $patterns[]    = '/##firstname##/';
1605     $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.'" />';
1606     $patterns[]    = '/##lastname##/';
1607     $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.'" />';
1609     // actual replacement of the tags
1610     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1612     $options = new stdClass();
1613     $options->para=false;
1614     $options->noclean=true;
1615     echo '<tr><td>';
1616     echo format_text($newtext, FORMAT_HTML, $options);
1617     echo '</td></tr>';
1619     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>';
1620     echo '</table>';
1621     echo '</div>';
1622     echo '</div>';
1623     echo '</form>';
1624     echo '</div>';
1627 /**
1628  * @global object
1629  * @global object
1630  * @param object $data
1631  * @param object $record
1632  * @return void Output echo'd
1633  */
1634 function data_print_ratings($data, $record) {
1635     global $OUTPUT;
1636     if (!empty($record->rating)){
1637         echo $OUTPUT->render($record->rating);
1638     }
1641 /**
1642  * For Participantion Reports
1643  *
1644  * @return array
1645  */
1646 function data_get_view_actions() {
1647     return array('view');
1650 /**
1651  * @return array
1652  */
1653 function data_get_post_actions() {
1654     return array('add','update','record delete');
1657 /**
1658  * @param string $name
1659  * @param int $dataid
1660  * @param int $fieldid
1661  * @return bool
1662  */
1663 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
1664     global $DB;
1666     if (!is_numeric($name)) {
1667         $like = $DB->sql_like('df.name', ':name', false);
1668     } else {
1669         $like = "df.name = :name";
1670     }
1671     $params = array('name'=>$name);
1672     if ($fieldid) {
1673         $params['dataid']   = $dataid;
1674         $params['fieldid1'] = $fieldid;
1675         $params['fieldid2'] = $fieldid;
1676         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1677                                         WHERE $like AND df.dataid = :dataid
1678                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
1679     } else {
1680         $params['dataid']   = $dataid;
1681         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1682                                         WHERE $like AND df.dataid = :dataid", $params);
1683     }
1686 /**
1687  * @param array $fieldinput
1688  */
1689 function data_convert_arrays_to_strings(&$fieldinput) {
1690     foreach ($fieldinput as $key => $val) {
1691         if (is_array($val)) {
1692             $str = '';
1693             foreach ($val as $inner) {
1694                 $str .= $inner . ',';
1695             }
1696             $str = substr($str, 0, -1);
1698             $fieldinput->$key = $str;
1699         }
1700     }
1704 /**
1705  * Converts a database (module instance) to use the Roles System
1706  *
1707  * @global object
1708  * @global object
1709  * @uses CONTEXT_MODULE
1710  * @uses CAP_PREVENT
1711  * @uses CAP_ALLOW
1712  * @param object $data a data object with the same attributes as a record
1713  *                     from the data database table
1714  * @param int $datamodid the id of the data module, from the modules table
1715  * @param array $teacherroles array of roles that have archetype teacher
1716  * @param array $studentroles array of roles that have archetype student
1717  * @param array $guestroles array of roles that have archetype guest
1718  * @param int $cmid the course_module id for this data instance
1719  * @return boolean data module was converted or not
1720  */
1721 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1722     global $CFG, $DB, $OUTPUT;
1724     if (!isset($data->participants) && !isset($data->assesspublic)
1725             && !isset($data->groupmode)) {
1726         // We assume that this database has already been converted to use the
1727         // Roles System. above fields get dropped the data module has been
1728         // upgraded to use Roles.
1729         return false;
1730     }
1732     if (empty($cmid)) {
1733         // We were not given the course_module id. Try to find it.
1734         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1735             echo $OUTPUT->notification('Could not get the course module for the data');
1736             return false;
1737         } else {
1738             $cmid = $cm->id;
1739         }
1740     }
1741     $context = context_module::instance($cmid);
1744     // $data->participants:
1745     // 1 - Only teachers can add entries
1746     // 3 - Teachers and students can add entries
1747     switch ($data->participants) {
1748         case 1:
1749             foreach ($studentroles as $studentrole) {
1750                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1751             }
1752             foreach ($teacherroles as $teacherrole) {
1753                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1754             }
1755             break;
1756         case 3:
1757             foreach ($studentroles as $studentrole) {
1758                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1759             }
1760             foreach ($teacherroles as $teacherrole) {
1761                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1762             }
1763             break;
1764     }
1766     // $data->assessed:
1767     // 2 - Only teachers can rate posts
1768     // 1 - Everyone can rate posts
1769     // 0 - No one can rate posts
1770     switch ($data->assessed) {
1771         case 0:
1772             foreach ($studentroles as $studentrole) {
1773                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1774             }
1775             foreach ($teacherroles as $teacherrole) {
1776                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1777             }
1778             break;
1779         case 1:
1780             foreach ($studentroles as $studentrole) {
1781                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1782             }
1783             foreach ($teacherroles as $teacherrole) {
1784                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1785             }
1786             break;
1787         case 2:
1788             foreach ($studentroles as $studentrole) {
1789                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1790             }
1791             foreach ($teacherroles as $teacherrole) {
1792                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1793             }
1794             break;
1795     }
1797     // $data->assesspublic:
1798     // 0 - Students can only see their own ratings
1799     // 1 - Students can see everyone's ratings
1800     switch ($data->assesspublic) {
1801         case 0:
1802             foreach ($studentroles as $studentrole) {
1803                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1804             }
1805             foreach ($teacherroles as $teacherrole) {
1806                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1807             }
1808             break;
1809         case 1:
1810             foreach ($studentroles as $studentrole) {
1811                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1812             }
1813             foreach ($teacherroles as $teacherrole) {
1814                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1815             }
1816             break;
1817     }
1819     if (empty($cm)) {
1820         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1821     }
1823     switch ($cm->groupmode) {
1824         case NOGROUPS:
1825             break;
1826         case SEPARATEGROUPS:
1827             foreach ($studentroles as $studentrole) {
1828                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1829             }
1830             foreach ($teacherroles as $teacherrole) {
1831                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1832             }
1833             break;
1834         case VISIBLEGROUPS:
1835             foreach ($studentroles as $studentrole) {
1836                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1837             }
1838             foreach ($teacherroles as $teacherrole) {
1839                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1840             }
1841             break;
1842     }
1843     return true;
1846 /**
1847  * Returns the best name to show for a preset
1848  *
1849  * @param string $shortname
1850  * @param  string $path
1851  * @return string
1852  */
1853 function data_preset_name($shortname, $path) {
1855     // We are looking inside the preset itself as a first choice, but also in normal data directory
1856     $string = get_string('modulename', 'datapreset_'.$shortname);
1858     if (substr($string, 0, 1) == '[') {
1859         return $shortname;
1860     } else {
1861         return $string;
1862     }
1865 /**
1866  * Returns an array of all the available presets.
1867  *
1868  * @return array
1869  */
1870 function data_get_available_presets($context) {
1871     global $CFG, $USER;
1873     $presets = array();
1875     // First load the ratings sub plugins that exist within the modules preset dir
1876     if ($dirs = get_list_of_plugins('mod/data/preset')) {
1877         foreach ($dirs as $dir) {
1878             $fulldir = $CFG->dirroot.'/mod/data/preset/'.$dir;
1879             if (is_directory_a_preset($fulldir)) {
1880                 $preset = new stdClass();
1881                 $preset->path = $fulldir;
1882                 $preset->userid = 0;
1883                 $preset->shortname = $dir;
1884                 $preset->name = data_preset_name($dir, $fulldir);
1885                 if (file_exists($fulldir.'/screenshot.jpg')) {
1886                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1887                 } else if (file_exists($fulldir.'/screenshot.png')) {
1888                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1889                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1890                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1891                 }
1892                 $presets[] = $preset;
1893             }
1894         }
1895     }
1896     // Now add to that the site presets that people have saved
1897     $presets = data_get_available_site_presets($context, $presets);
1898     return $presets;
1901 /**
1902  * Gets an array of all of the presets that users have saved to the site.
1903  *
1904  * @param stdClass $context The context that we are looking from.
1905  * @param array $presets
1906  * @return array An array of presets
1907  */
1908 function data_get_available_site_presets($context, array $presets=array()) {
1909     global $USER;
1911     $fs = get_file_storage();
1912     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
1913     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
1914     if (empty($files)) {
1915         return $presets;
1916     }
1917     foreach ($files as $file) {
1918         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
1919             continue;
1920         }
1921         $preset = new stdClass;
1922         $preset->path = $file->get_filepath();
1923         $preset->name = trim($preset->path, '/');
1924         $preset->shortname = $preset->name;
1925         $preset->userid = $file->get_userid();
1926         $preset->id = $file->get_id();
1927         $preset->storedfile = $file;
1928         $presets[] = $preset;
1929     }
1930     return $presets;
1933 /**
1934  * Deletes a saved preset.
1935  *
1936  * @param string $name
1937  * @return bool
1938  */
1939 function data_delete_site_preset($name) {
1940     $fs = get_file_storage();
1942     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
1943     if (!empty($files)) {
1944         foreach ($files as $file) {
1945             $file->delete();
1946         }
1947     }
1949     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
1950     if (!empty($dir)) {
1951         $dir->delete();
1952     }
1953     return true;
1956 /**
1957  * Prints the heads for a page
1958  *
1959  * @param stdClass $course
1960  * @param stdClass $cm
1961  * @param stdClass $data
1962  * @param string $currenttab
1963  */
1964 function data_print_header($course, $cm, $data, $currenttab='') {
1966     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
1968     $PAGE->set_title($data->name);
1969     echo $OUTPUT->header();
1970     echo $OUTPUT->heading(format_string($data->name));
1972 // Groups needed for Add entry tab
1973     $currentgroup = groups_get_activity_group($cm);
1974     $groupmode = groups_get_activity_groupmode($cm);
1976     // Print the tabs
1978     if ($currenttab) {
1979         include('tabs.php');
1980     }
1982     // Print any notices
1984     if (!empty($displaynoticegood)) {
1985         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
1986     } else if (!empty($displaynoticebad)) {
1987         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
1988     }
1991 /**
1992  * Can user add more entries?
1993  *
1994  * @param object $data
1995  * @param mixed $currentgroup
1996  * @param int $groupmode
1997  * @param stdClass $context
1998  * @return bool
1999  */
2000 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2001     global $USER;
2003     if (empty($context)) {
2004         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2005         $context = context_module::instance($cm->id);
2006     }
2008     if (has_capability('mod/data:manageentries', $context)) {
2009         // no entry limits apply if user can manage
2011     } else if (!has_capability('mod/data:writeentry', $context)) {
2012         return false;
2014     } else if (data_atmaxentries($data)) {
2015         return false;
2016     } else if (data_in_readonly_period($data)) {
2017         // Check whether we're in a read-only period
2018         return false;
2019     }
2021     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2022         return true;
2023     }
2025     if ($currentgroup) {
2026         return groups_is_member($currentgroup);
2027     } else {
2028         //else it might be group 0 in visible mode
2029         if ($groupmode == VISIBLEGROUPS){
2030             return true;
2031         } else {
2032             return false;
2033         }
2034     }
2037 /**
2038  * Check whether the specified database activity is currently in a read-only period
2039  *
2040  * @param object $data
2041  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2042  */
2043 function data_in_readonly_period($data) {
2044     $now = time();
2045     if (!$data->timeviewfrom && !$data->timeviewto) {
2046         return false;
2047     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2048         return false;
2049     }
2050     return true;
2053 /**
2054  * @return bool
2055  */
2056 function is_directory_a_preset($directory) {
2057     $directory = rtrim($directory, '/\\') . '/';
2058     $status = file_exists($directory.'singletemplate.html') &&
2059               file_exists($directory.'listtemplate.html') &&
2060               file_exists($directory.'listtemplateheader.html') &&
2061               file_exists($directory.'listtemplatefooter.html') &&
2062               file_exists($directory.'addtemplate.html') &&
2063               file_exists($directory.'rsstemplate.html') &&
2064               file_exists($directory.'rsstitletemplate.html') &&
2065               file_exists($directory.'csstemplate.css') &&
2066               file_exists($directory.'jstemplate.js') &&
2067               file_exists($directory.'preset.xml');
2069     return $status;
2072 /**
2073  * Abstract class used for data preset importers
2074  */
2075 abstract class data_preset_importer {
2077     protected $course;
2078     protected $cm;
2079     protected $module;
2080     protected $directory;
2082     /**
2083      * Constructor
2084      *
2085      * @param stdClass $course
2086      * @param stdClass $cm
2087      * @param stdClass $module
2088      * @param string $directory
2089      */
2090     public function __construct($course, $cm, $module, $directory) {
2091         $this->course = $course;
2092         $this->cm = $cm;
2093         $this->module = $module;
2094         $this->directory = $directory;
2095     }
2097     /**
2098      * Returns the name of the directory the preset is located in
2099      * @return string
2100      */
2101     public function get_directory() {
2102         return basename($this->directory);
2103     }
2105     /**
2106      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2107      * @param file_storage $filestorage. should be null if using a conventional directory
2108      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2109      * @param string $dir the directory to look in. null if using the Moodle file storage
2110      * @param string $filename the name of the file we want
2111      * @return string the contents of the file
2112      */
2113     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2114         if(empty($filestorage) || empty($fileobj)) {
2115             if (substr($dir, -1)!='/') {
2116                 $dir .= '/';
2117             }
2118             return file_get_contents($dir.$filename);
2119         } else {
2120             $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2121             return $file->get_content();
2122         }
2124     }
2125     /**
2126      * Gets the preset settings
2127      * @global moodle_database $DB
2128      * @return stdClass
2129      */
2130     public function get_preset_settings() {
2131         global $DB;
2133         $fs = $fileobj = null;
2134         if (!is_directory_a_preset($this->directory)) {
2135             //maybe the user requested a preset stored in the Moodle file storage
2137             $fs = get_file_storage();
2138             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2140             //preset name to find will be the final element of the directory
2141             $presettofind = end(explode('/',$this->directory));
2143             //now go through the available files available and see if we can find it
2144             foreach ($files as $file) {
2145                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2146                     continue;
2147                 }
2148                 $presetname = trim($file->get_filepath(), '/');
2149                 if ($presetname==$presettofind) {
2150                     $this->directory = $presetname;
2151                     $fileobj = $file;
2152                 }
2153             }
2155             if (empty($fileobj)) {
2156                 print_error('invalidpreset', 'data', '', $this->directory);
2157             }
2158         }
2160         $allowed_settings = array(
2161             'intro',
2162             'comments',
2163             'requiredentries',
2164             'requiredentriestoview',
2165             'maxentries',
2166             'rssarticles',
2167             'approval',
2168             'defaultsortdir',
2169             'defaultsort');
2171         $result = new stdClass;
2172         $result->settings = new stdClass;
2173         $result->importfields = array();
2174         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2175         if (!$result->currentfields) {
2176             $result->currentfields = array();
2177         }
2180         /* Grab XML */
2181         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2182         $parsedxml = xmlize($presetxml, 0);
2184         /* First, do settings. Put in user friendly array. */
2185         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2186         $result->settings = new StdClass();
2187         foreach ($settingsarray as $setting => $value) {
2188             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2189                 // unsupported setting
2190                 continue;
2191             }
2192             $result->settings->$setting = $value[0]['#'];
2193         }
2195         /* Now work out fields to user friendly array */
2196         $fieldsarray = $parsedxml['preset']['#']['field'];
2197         foreach ($fieldsarray as $field) {
2198             if (!is_array($field)) {
2199                 continue;
2200             }
2201             $f = new StdClass();
2202             foreach ($field['#'] as $param => $value) {
2203                 if (!is_array($value)) {
2204                     continue;
2205                 }
2206                 $f->$param = $value[0]['#'];
2207             }
2208             $f->dataid = $this->module->id;
2209             $f->type = clean_param($f->type, PARAM_ALPHA);
2210             $result->importfields[] = $f;
2211         }
2212         /* Now add the HTML templates to the settings array so we can update d */
2213         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2214         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2215         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2216         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2217         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2218         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2219         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2220         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2221         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2223         //optional
2224         if (file_exists($this->directory."/asearchtemplate.html")) {
2225             $result->settings->asearchtemplate = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2226         } else {
2227             $result->settings->asearchtemplate = NULL;
2228         }
2229         $result->settings->instance = $this->module->id;
2231         return $result;
2232     }
2234     /**
2235      * Import the preset into the given database module
2236      * @return bool
2237      */
2238     function import($overwritesettings) {
2239         global $DB, $CFG;
2241         $params = $this->get_preset_settings();
2242         $settings = $params->settings;
2243         $newfields = $params->importfields;
2244         $currentfields = $params->currentfields;
2245         $preservedfields = array();
2247         /* Maps fields and makes new ones */
2248         if (!empty($newfields)) {
2249             /* We require an injective mapping, and need to know what to protect */
2250             foreach ($newfields as $nid => $newfield) {
2251                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2252                 if ($cid == -1) {
2253                     continue;
2254                 }
2255                 if (array_key_exists($cid, $preservedfields)){
2256                     print_error('notinjectivemap', 'data');
2257                 }
2258                 else $preservedfields[$cid] = true;
2259             }
2261             foreach ($newfields as $nid => $newfield) {
2262                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2264                 /* A mapping. Just need to change field params. Data kept. */
2265                 if ($cid != -1 and isset($currentfields[$cid])) {
2266                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2267                     foreach ($newfield as $param => $value) {
2268                         if ($param != "id") {
2269                             $fieldobject->field->$param = $value;
2270                         }
2271                     }
2272                     unset($fieldobject->field->similarfield);
2273                     $fieldobject->update_field();
2274                     unset($fieldobject);
2275                 } else {
2276                     /* Make a new field */
2277                     include_once("field/$newfield->type/field.class.php");
2279                     if (!isset($newfield->description)) {
2280                         $newfield->description = '';
2281                     }
2282                     $classname = 'data_field_'.$newfield->type;
2283                     $fieldclass = new $classname($newfield, $this->module);
2284                     $fieldclass->insert_field();
2285                     unset($fieldclass);
2286                 }
2287             }
2288         }
2290         /* Get rid of all old unused data */
2291         if (!empty($preservedfields)) {
2292             foreach ($currentfields as $cid => $currentfield) {
2293                 if (!array_key_exists($cid, $preservedfields)) {
2294                     /* Data not used anymore so wipe! */
2295                     print "Deleting field $currentfield->name<br />";
2297                     $id = $currentfield->id;
2298                     //Why delete existing data records and related comments/ratings??
2299                     $DB->delete_records('data_content', array('fieldid'=>$id));
2300                     $DB->delete_records('data_fields', array('id'=>$id));
2301                 }
2302             }
2303         }
2305         // handle special settings here
2306         if (!empty($settings->defaultsort)) {
2307             if (is_numeric($settings->defaultsort)) {
2308                 // old broken value
2309                 $settings->defaultsort = 0;
2310             } else {
2311                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2312             }
2313         } else {
2314             $settings->defaultsort = 0;
2315         }
2317         // do we want to overwrite all current database settings?
2318         if ($overwritesettings) {
2319             // all supported settings
2320             $overwrite = array_keys((array)$settings);
2321         } else {
2322             // only templates and sorting
2323             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2324                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2325                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2326         }
2328         // now overwrite current data settings
2329         foreach ($this->module as $prop=>$unused) {
2330             if (in_array($prop, $overwrite)) {
2331                 $this->module->$prop = $settings->$prop;
2332             }
2333         }
2335         data_update_instance($this->module);
2337         return $this->cleanup();
2338     }
2340     /**
2341      * Any clean up routines should go here
2342      * @return bool
2343      */
2344     public function cleanup() {
2345         return true;
2346     }
2349 /**
2350  * Data preset importer for uploaded presets
2351  */
2352 class data_preset_upload_importer extends data_preset_importer {
2353     public function __construct($course, $cm, $module, $filepath) {
2354         global $USER;
2355         if (is_file($filepath)) {
2356             $fp = get_file_packer();
2357             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2358                 fulldelete($filepath);
2359             }
2360             $filepath .= '_extracted';
2361         }
2362         parent::__construct($course, $cm, $module, $filepath);
2363     }
2364     public function cleanup() {
2365         return fulldelete($this->directory);
2366     }
2369 /**
2370  * Data preset importer for existing presets
2371  */
2372 class data_preset_existing_importer extends data_preset_importer {
2373     protected $userid;
2374     public function __construct($course, $cm, $module, $fullname) {
2375         global $USER;
2376         list($userid, $shortname) = explode('/', $fullname, 2);
2377         $context = context_module::instance($cm->id);
2378         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2379            throw new coding_exception('Invalid preset provided');
2380         }
2382         $this->userid = $userid;
2383         $filepath = data_preset_path($course, $userid, $shortname);
2384         parent::__construct($course, $cm, $module, $filepath);
2385     }
2386     public function get_userid() {
2387         return $this->userid;
2388     }
2391 /**
2392  * @global object
2393  * @global object
2394  * @param object $course
2395  * @param int $userid
2396  * @param string $shortname
2397  * @return string
2398  */
2399 function data_preset_path($course, $userid, $shortname) {
2400     global $USER, $CFG;
2402     $context = context_course::instance($course->id);
2404     $userid = (int)$userid;
2406     $path = null;
2407     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2408         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2409     } else if ($userid == 0) {
2410         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2411     } else if ($userid < 0) {
2412         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2413     }
2415     return $path;
2418 /**
2419  * Implementation of the function for printing the form elements that control
2420  * whether the course reset functionality affects the data.
2421  *
2422  * @param $mform form passed by reference
2423  */
2424 function data_reset_course_form_definition(&$mform) {
2425     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2426     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2428     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2429     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2431     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2432     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2434     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2435     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2438 /**
2439  * Course reset form defaults.
2440  * @return array
2441  */
2442 function data_reset_course_form_defaults($course) {
2443     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2446 /**
2447  * Removes all grades from gradebook
2448  *
2449  * @global object
2450  * @global object
2451  * @param int $courseid
2452  * @param string $type optional type
2453  */
2454 function data_reset_gradebook($courseid, $type='') {
2455     global $CFG, $DB;
2457     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2458               FROM {data} d, {course_modules} cm, {modules} m
2459              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2461     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2462         foreach ($datas as $data) {
2463             data_grade_item_update($data, 'reset');
2464         }
2465     }
2468 /**
2469  * Actual implementation of the reset course functionality, delete all the
2470  * data responses for course $data->courseid.
2471  *
2472  * @global object
2473  * @global object
2474  * @param object $data the data submitted from the reset course.
2475  * @return array status array
2476  */
2477 function data_reset_userdata($data) {
2478     global $CFG, $DB;
2479     require_once($CFG->libdir.'/filelib.php');
2480     require_once($CFG->dirroot.'/rating/lib.php');
2482     $componentstr = get_string('modulenameplural', 'data');
2483     $status = array();
2485     $allrecordssql = "SELECT r.id
2486                         FROM {data_records} r
2487                              INNER JOIN {data} d ON r.dataid = d.id
2488                        WHERE d.course = ?";
2490     $alldatassql = "SELECT d.id
2491                       FROM {data} d
2492                      WHERE d.course=?";
2494     $rm = new rating_manager();
2495     $ratingdeloptions = new stdClass;
2496     $ratingdeloptions->component = 'mod_data';
2497     $ratingdeloptions->ratingarea = 'entry';
2499     // delete entries if requested
2500     if (!empty($data->reset_data)) {
2501         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2502         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2503         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2505         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2506             foreach ($datas as $dataid=>$unused) {
2507                 fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$dataid");
2509                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2510                     continue;
2511                 }
2512                 $datacontext = context_module::instance($cm->id);
2514                 $ratingdeloptions->contextid = $datacontext->id;
2515                 $rm->delete_ratings($ratingdeloptions);
2516             }
2517         }
2519         if (empty($data->reset_gradebook_grades)) {
2520             // remove all grades from gradebook
2521             data_reset_gradebook($data->courseid);
2522         }
2523         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2524     }
2526     // remove entries by users not enrolled into course
2527     if (!empty($data->reset_data_notenrolled)) {
2528         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2529                          FROM {data_records} r
2530                               JOIN {data} d ON r.dataid = d.id
2531                               LEFT JOIN {user} u ON r.userid = u.id
2532                         WHERE d.course = ? AND r.userid > 0";
2534         $course_context = context_course::instance($data->courseid);
2535         $notenrolled = array();
2536         $fields = array();
2537         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2538         foreach ($rs as $record) {
2539             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2540               or !is_enrolled($course_context, $record->userid)) {
2541                 //delete ratings
2542                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2543                     continue;
2544                 }
2545                 $datacontext = context_module::instance($cm->id);
2546                 $ratingdeloptions->contextid = $datacontext->id;
2547                 $ratingdeloptions->itemid = $record->id;
2548                 $rm->delete_ratings($ratingdeloptions);
2550                 $DB->delete_records('comments', array('itemid'=>$record->id, 'commentarea'=>'database_entry'));
2551                 $DB->delete_records('data_content', array('recordid'=>$record->id));
2552                 $DB->delete_records('data_records', array('id'=>$record->id));
2553                 // HACK: this is ugly - the recordid should be before the fieldid!
2554                 if (!array_key_exists($record->dataid, $fields)) {
2555                     if ($fs = $DB->get_records('data_fields', array('dataid'=>$record->dataid))) {
2556                         $fields[$record->dataid] = array_keys($fs);
2557                     } else {
2558                         $fields[$record->dataid] = array();
2559                     }
2560                 }
2561                 foreach($fields[$record->dataid] as $fieldid) {
2562                     fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$record->dataid/$fieldid/$record->id");
2563                 }
2564                 $notenrolled[$record->userid] = true;
2565             }
2566         }
2567         $rs->close();
2568         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2569     }
2571     // remove all ratings
2572     if (!empty($data->reset_data_ratings)) {
2573         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2574             foreach ($datas as $dataid=>$unused) {
2575                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2576                     continue;
2577                 }
2578                 $datacontext = context_module::instance($cm->id);
2580                 $ratingdeloptions->contextid = $datacontext->id;
2581                 $rm->delete_ratings($ratingdeloptions);
2582             }
2583         }
2585         if (empty($data->reset_gradebook_grades)) {
2586             // remove all grades from gradebook
2587             data_reset_gradebook($data->courseid);
2588         }
2590         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2591     }
2593     // remove all comments
2594     if (!empty($data->reset_data_comments)) {
2595         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2596         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2597     }
2599     // updating dates - shift may be negative too
2600     if ($data->timeshift) {
2601         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2602         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2603     }
2605     return $status;
2608 /**
2609  * Returns all other caps used in module
2610  *
2611  * @return array
2612  */
2613 function data_get_extra_capabilities() {
2614     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');
2617 /**
2618  * @param string $feature FEATURE_xx constant for requested feature
2619  * @return mixed True if module supports feature, null if doesn't know
2620  */
2621 function data_supports($feature) {
2622     switch($feature) {
2623         case FEATURE_GROUPS:                  return true;
2624         case FEATURE_GROUPINGS:               return true;
2625         case FEATURE_GROUPMEMBERSONLY:        return true;
2626         case FEATURE_MOD_INTRO:               return true;
2627         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2628         case FEATURE_GRADE_HAS_GRADE:         return true;
2629         case FEATURE_GRADE_OUTCOMES:          return true;
2630         case FEATURE_RATE:                    return true;
2631         case FEATURE_BACKUP_MOODLE2:          return true;
2632         case FEATURE_SHOW_DESCRIPTION:        return true;
2634         default: return null;
2635     }
2637 /**
2638  * @global object
2639  * @param array $export
2640  * @param string $delimiter_name
2641  * @param object $database
2642  * @param int $count
2643  * @param bool $return
2644  * @return string|void
2645  */
2646 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
2647     global $CFG;
2648     require_once($CFG->libdir . '/csvlib.class.php');
2650     $filename = $database . '-' . $count . '-record';
2651     if ($count > 1) {
2652         $filename .= 's';
2653     }
2654     if ($return) {
2655         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
2656     } else {
2657         csv_export_writer::download_array($filename, $export, $delimiter_name);
2658     }
2661 /**
2662  * @global object
2663  * @param array $export
2664  * @param string $dataname
2665  * @param int $count
2666  * @return string
2667  */
2668 function data_export_xls($export, $dataname, $count) {
2669     global $CFG;
2670     require_once("$CFG->libdir/excellib.class.php");
2671     $filename = clean_filename("{$dataname}-{$count}_record");
2672     if ($count > 1) {
2673         $filename .= 's';
2674     }
2675     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2676     $filename .= '.xls';
2678     $filearg = '-';
2679     $workbook = new MoodleExcelWorkbook($filearg);
2680     $workbook->send($filename);
2681     $worksheet = array();
2682     $worksheet[0] =& $workbook->add_worksheet('');
2683     $rowno = 0;
2684     foreach ($export as $row) {
2685         $colno = 0;
2686         foreach($row as $col) {
2687             $worksheet[0]->write($rowno, $colno, $col);
2688             $colno++;
2689         }
2690         $rowno++;
2691     }
2692     $workbook->close();
2693     return $filename;
2696 /**
2697  * @global object
2698  * @param array $export
2699  * @param string $dataname
2700  * @param int $count
2701  * @param string
2702  */
2703 function data_export_ods($export, $dataname, $count) {
2704     global $CFG;
2705     require_once("$CFG->libdir/odslib.class.php");
2706     $filename = clean_filename("{$dataname}-{$count}_record");
2707     if ($count > 1) {
2708         $filename .= 's';
2709     }
2710     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2711     $filename .= '.ods';
2712     $filearg = '-';
2713     $workbook = new MoodleODSWorkbook($filearg);
2714     $workbook->send($filename);
2715     $worksheet = array();
2716     $worksheet[0] =& $workbook->add_worksheet('');
2717     $rowno = 0;
2718     foreach ($export as $row) {
2719         $colno = 0;
2720         foreach($row as $col) {
2721             $worksheet[0]->write($rowno, $colno, $col);
2722             $colno++;
2723         }
2724         $rowno++;
2725     }
2726     $workbook->close();
2727     return $filename;
2730 /**
2731  * @global object
2732  * @param int $dataid
2733  * @param array $fields
2734  * @param array $selectedfields
2735  * @param int $currentgroup group ID of the current group. This is used for
2736  * exporting data while maintaining group divisions.
2737  * @param object $context the context in which the operation is performed (for capability checks)
2738  * @param bool $userdetails whether to include the details of the record author
2739  * @param bool $time whether to include time created/modified
2740  * @param bool $approval whether to include approval status
2741  * @return array
2742  */
2743 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
2744                              $userdetails=false, $time=false, $approval=false) {
2745     global $DB;
2747     if (is_null($context)) {
2748         $context = context_system::instance();
2749     }
2750     // exporting user data needs special permission
2751     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
2753     $exportdata = array();
2755     // populate the header in first row of export
2756     foreach($fields as $key => $field) {
2757         if (!in_array($field->field->id, $selectedfields)) {
2758             // ignore values we aren't exporting
2759             unset($fields[$key]);
2760         } else {
2761             $exportdata[0][] = $field->field->name;
2762         }
2763     }
2764     if ($userdetails) {
2765         $exportdata[0][] = get_string('user');
2766         $exportdata[0][] = get_string('username');
2767         $exportdata[0][] = get_string('email');
2768     }
2769     if ($time) {
2770         $exportdata[0][] = get_string('timeadded', 'data');
2771         $exportdata[0][] = get_string('timemodified', 'data');
2772     }
2773     if ($approval) {
2774         $exportdata[0][] = get_string('approved', 'data');
2775     }
2777     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2778     ksort($datarecords);
2779     $line = 1;
2780     foreach($datarecords as $record) {
2781         // get content indexed by fieldid
2782         if ($currentgroup) {
2783             $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 = ?';
2784             $where = array($record->id, $currentgroup);
2785         } else {
2786             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
2787             $where = array($record->id);
2788         }
2790         if( $content = $DB->get_records_sql($select, $where) ) {
2791             foreach($fields as $field) {
2792                 $contents = '';
2793                 if(isset($content[$field->field->id])) {
2794                     $contents = $field->export_text_value($content[$field->field->id]);
2795                 }
2796                 $exportdata[$line][] = $contents;
2797             }
2798             if ($userdetails) { // Add user details to the export data
2799                 $userdata = get_complete_user_data('id', $record->userid);
2800                 $exportdata[$line][] = fullname($userdata);
2801                 $exportdata[$line][] = $userdata->username;
2802                 $exportdata[$line][] = $userdata->email;
2803             }
2804             if ($time) { // Add time added / modified
2805                 $exportdata[$line][] = userdate($record->timecreated);
2806                 $exportdata[$line][] = userdate($record->timemodified);
2807             }
2808             if ($approval) { // Add approval status
2809                 $exportdata[$line][] = (int) $record->approved;
2810             }
2811         }
2812         $line++;
2813     }
2814     $line--;
2815     return $exportdata;
2818 ////////////////////////////////////////////////////////////////////////////////
2819 // File API                                                                   //
2820 ////////////////////////////////////////////////////////////////////////////////
2822 /**
2823  * Lists all browsable file areas
2824  *
2825  * @package  mod_data
2826  * @category files
2827  * @param stdClass $course course object
2828  * @param stdClass $cm course module object
2829  * @param stdClass $context context object
2830  * @return array
2831  */
2832 function data_get_file_areas($course, $cm, $context) {
2833     return array('content' => get_string('areacontent', 'mod_data'));
2836 /**
2837  * File browsing support for data module.
2838  *
2839  * @param file_browser $browser
2840  * @param array $areas
2841  * @param stdClass $course
2842  * @param cm_info $cm
2843  * @param context $context
2844  * @param string $filearea
2845  * @param int $itemid
2846  * @param string $filepath
2847  * @param string $filename
2848  * @return file_info_stored file_info_stored instance or null if not found
2849  */
2850 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
2851     global $CFG, $DB, $USER;
2853     if ($context->contextlevel != CONTEXT_MODULE) {
2854         return null;
2855     }
2857     if (!isset($areas[$filearea])) {
2858         return null;
2859     }
2861     if (is_null($itemid)) {
2862         require_once($CFG->dirroot.'/mod/data/locallib.php');
2863         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
2864     }
2866     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
2867         return null;
2868     }
2870     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2871         return null;
2872     }
2874     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2875         return null;
2876     }
2878     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2879         return null;
2880     }
2882     //check if approved
2883     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2884         return null;
2885     }
2887     // group access
2888     if ($record->groupid) {
2889         $groupmode = groups_get_activity_groupmode($cm, $course);
2890         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2891             if (!groups_is_member($record->groupid)) {
2892                 return null;
2893             }
2894         }
2895     }
2897     $fieldobj = data_get_field($field, $data, $cm);
2899     $filepath = is_null($filepath) ? '/' : $filepath;
2900     $filename = is_null($filename) ? '.' : $filename;
2901     if (!$fieldobj->file_ok($filepath.$filename)) {
2902         return null;
2903     }
2905     $fs = get_file_storage();
2906     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
2907         return null;
2908     }
2910     // Checks to see if the user can manage files or is the owner.
2911     // TODO MDL-33805 - Do not use userid here and move the capability check above.
2912     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
2913         return null;
2914     }
2916     $urlbase = $CFG->wwwroot.'/pluginfile.php';
2918     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
2921 /**
2922  * Serves the data attachments. Implements needed access control ;-)
2923  *
2924  * @package  mod_data
2925  * @category files
2926  * @param stdClass $course course object
2927  * @param stdClass $cm course module object
2928  * @param stdClass $context context object
2929  * @param string $filearea file area
2930  * @param array $args extra arguments
2931  * @param bool $forcedownload whether or not force download
2932  * @param array $options additional options affecting the file serving
2933  * @return bool false if file not found, does not return if found - justsend the file
2934  */
2935 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
2936     global $CFG, $DB;
2938     if ($context->contextlevel != CONTEXT_MODULE) {
2939         return false;
2940     }
2942     require_course_login($course, true, $cm);
2944     if ($filearea === 'content') {
2945         $contentid = (int)array_shift($args);
2947         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
2948             return false;
2949         }
2951         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2952             return false;
2953         }
2955         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2956             return false;
2957         }
2959         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2960             return false;
2961         }
2963         if ($data->id != $cm->instance) {
2964             // hacker attempt - context does not match the contentid
2965             return false;
2966         }
2968         //check if approved
2969         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2970             return false;
2971         }
2973         // group access
2974         if ($record->groupid) {
2975             $groupmode = groups_get_activity_groupmode($cm, $course);
2976             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2977                 if (!groups_is_member($record->groupid)) {
2978                     return false;
2979                 }
2980             }
2981         }
2983         $fieldobj = data_get_field($field, $data, $cm);
2985         $relativepath = implode('/', $args);
2986         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
2988         if (!$fieldobj->file_ok($relativepath)) {
2989             return false;
2990         }
2992         $fs = get_file_storage();
2993         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2994             return false;
2995         }
2997         // finally send the file
2998         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
2999     }
3001     return false;
3005 function data_extend_navigation($navigation, $course, $module, $cm) {
3006     global $CFG, $OUTPUT, $USER, $DB;
3008     $rid = optional_param('rid', 0, PARAM_INT);
3010     $data = $DB->get_record('data', array('id'=>$cm->instance));
3011     $currentgroup = groups_get_activity_group($cm);
3012     $groupmode = groups_get_activity_groupmode($cm);
3014      $numentries = data_numentries($data);
3015     /// Check the number of entries required against the number of entries already made (doesn't apply to teachers)
3016     if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !has_capability('mod/data:manageentries', context_module::instance($cm->id))) {
3017         $data->entriesleft = $data->requiredentries - $numentries;
3018         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3019         $entriesnode->add_class('note');
3020     }
3022     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3023     if (!empty($rid)) {
3024         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3025     } else {
3026         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3027     }
3028     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3031 /**
3032  * Adds module specific settings to the settings block
3033  *
3034  * @param settings_navigation $settings The settings navigation object
3035  * @param navigation_node $datanode The node to add module settings to
3036  */
3037 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3038     global $PAGE, $DB, $CFG, $USER;
3040     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3042     $currentgroup = groups_get_activity_group($PAGE->cm);
3043     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3045     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3046         if (empty($editentry)) { //TODO: undefined
3047             $addstring = get_string('add', 'data');
3048         } else {
3049             $addstring = get_string('editentry', 'data');
3050         }
3051         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3052     }
3054     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3055         // The capability required to Export database records is centrally defined in 'lib.php'
3056         // and should be weaker than those required to edit Templates, Fields and Presets.
3057         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3058     }
3059     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3060         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3061     }
3063     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3064         $currenttab = '';
3065         if ($currenttab == 'list') {
3066             $defaultemplate = 'listtemplate';
3067         } else if ($currenttab == 'add') {
3068             $defaultemplate = 'addtemplate';
3069         } else if ($currenttab == 'asearch') {
3070             $defaultemplate = 'asearchtemplate';
3071         } else {
3072             $defaultemplate = 'singletemplate';
3073         }
3075         $templates = $datanode->add(get_string('templates', 'data'));
3077         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3078         foreach ($templatelist as $template) {
3079             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3080         }
3082         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3083         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3084     }
3086     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3087         require_once("$CFG->libdir/rsslib.php");
3089         $string = get_string('rsstype','forum');
3091         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3092         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3093     }
3096 /**
3097  * Save the database configuration as a preset.
3098  *
3099  * @param stdClass $course The course the database module belongs to.
3100  * @param stdClass $cm The course module record
3101  * @param stdClass $data The database record
3102  * @param string $path
3103  * @return bool
3104  */
3105 function data_presets_save($course, $cm, $data, $path) {
3106     global $USER;
3107     $fs = get_file_storage();
3108     $filerecord = new stdClass;
3109     $filerecord->contextid = DATA_PRESET_CONTEXT;
3110     $filerecord->component = DATA_PRESET_COMPONENT;
3111     $filerecord->filearea = DATA_PRESET_FILEAREA;
3112     $filerecord->itemid = 0;
3113     $filerecord->filepath = '/'.$path.'/';
3114     $filerecord->userid = $USER->id;
3116     $filerecord->filename = 'preset.xml';
3117     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3119     $filerecord->filename = 'singletemplate.html';
3120     $fs->create_file_from_string($filerecord, $data->singletemplate);
3122     $filerecord->filename = 'listtemplateheader.html';
3123     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3125     $filerecord->filename = 'listtemplate.html';
3126     $fs->create_file_from_string($filerecord, $data->listtemplate);
3128     $filerecord->filename = 'listtemplatefooter.html';
3129     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3131     $filerecord->filename = 'addtemplate.html';
3132     $fs->create_file_from_string($filerecord, $data->addtemplate);
3134     $filerecord->filename = 'rsstemplate.html';
3135     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3137     $filerecord->filename = 'rsstitletemplate.html';
3138     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3140     $filerecord->filename = 'csstemplate.css';
3141     $fs->create_file_from_string($filerecord, $data->csstemplate);
3143     $filerecord->filename = 'jstemplate.js';
3144     $fs->create_file_from_string($filerecord, $data->jstemplate);
3146     $filerecord->filename = 'asearchtemplate.html';
3147     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3149     return true;
3152 /**
3153  * Generates the XML for the database module provided
3154  *
3155  * @global moodle_database $DB
3156  * @param stdClass $course The course the database module belongs to.
3157  * @param stdClass $cm The course module record
3158  * @param stdClass $data The database record
3159  * @return string The XML for the preset
3160  */
3161 function data_presets_generate_xml($course, $cm, $data) {
3162     global $DB;
3164     // Assemble "preset.xml":
3165     $presetxmldata = "<preset>\n\n";
3167     // Raw settings are not preprocessed during saving of presets
3168     $raw_settings = array(
3169         'intro',
3170         'comments',
3171         'requiredentries',
3172         'requiredentriestoview',
3173         'maxentries',
3174         'rssarticles',
3175         'approval',
3176         'defaultsortdir'
3177     );
3179     $presetxmldata .= "<settings>\n";
3180     // First, settings that do not require any conversion
3181     foreach ($raw_settings as $setting) {
3182         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3183     }
3185     // Now specific settings
3186     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3187         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3188     } else {
3189         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3190     }
3191     $presetxmldata .= "</settings>\n\n";
3192     // Now for the fields. Grab all that are non-empty
3193     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3194     ksort($fields);
3195     if (!empty($fields)) {
3196         foreach ($fields as $field) {
3197             $presetxmldata .= "<field>\n";
3198             foreach ($field as $key => $value) {
3199                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3200                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3201                 }
3202             }
3203             $presetxmldata .= "</field>\n\n";
3204         }
3205     }
3206     $presetxmldata .= '</preset>';
3207     return $presetxmldata;
3210 function data_presets_export($course, $cm, $data, $tostorage=false) {
3211     global $CFG, $DB;
3213     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3214     $exportsubdir = "mod_data/presetexport/$presetname";
3215     make_temp_directory($exportsubdir);
3216     $exportdir = "$CFG->tempdir/$exportsubdir";
3218     // Assemble "preset.xml":
3219     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3221     // After opening a file in write mode, close it asap
3222     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3223     fwrite($presetxmlfile, $presetxmldata);
3224     fclose($presetxmlfile);
3226     // Now write the template files
3227     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3228     fwrite($singletemplate, $data->singletemplate);
3229     fclose($singletemplate);
3231     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3232     fwrite($listtemplateheader, $data->listtemplateheader);
3233     fclose($listtemplateheader);
3235     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3236     fwrite($listtemplate, $data->listtemplate);
3237     fclose($listtemplate);
3239     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3240     fwrite($listtemplatefooter, $data->listtemplatefooter);
3241     fclose($listtemplatefooter);
3243     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3244     fwrite($addtemplate, $data->addtemplate);
3245     fclose($addtemplate);
3247     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3248     fwrite($rsstemplate, $data->rsstemplate);
3249     fclose($rsstemplate);
3251     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3252     fwrite($rsstitletemplate, $data->rsstitletemplate);
3253     fclose($rsstitletemplate);
3255     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3256     fwrite($csstemplate, $data->csstemplate);
3257     fclose($csstemplate);
3259     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3260     fwrite($jstemplate, $data->jstemplate);
3261     fclose($jstemplate);
3263     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3264     fwrite($asearchtemplate, $data->asearchtemplate);
3265     fclose($asearchtemplate);
3267     // Check if all files have been generated
3268     if (! is_directory_a_preset($exportdir)) {
3269         print_error('generateerror', 'data');
3270     }
3272     $filenames = array(
3273         'preset.xml',
3274         'singletemplate.html',
3275         'listtemplateheader.html',
3276         'listtemplate.html',
3277         'listtemplatefooter.html',
3278         'addtemplate.html',
3279         'rsstemplate.html',
3280         'rsstitletemplate.html',
3281         'csstemplate.css',
3282         'jstemplate.js',
3283         'asearchtemplate.html'
3284     );
3286     $filelist = array();
3287     foreach ($filenames as $filename) {
3288         $filelist[$filename] = $exportdir . '/' . $filename;
3289     }
3291     $exportfile = $exportdir.'.zip';
3292     file_exists($exportfile) && unlink($exportfile);
3294     $fp = get_file_packer('application/zip');
3295     $fp->archive_to_pathname($filelist, $exportfile);
3297     foreach ($filelist as $file) {
3298         unlink($file);
3299     }
3300     rmdir($exportdir);
3302     // Return the full path to the exported preset file:
3303     return $exportfile;
3306 /**
3307  * Running addtional permission check on plugin, for example, plugins
3308  * may have switch to turn on/off comments option, this callback will
3309  * affect UI display, not like pluginname_comment_validate only throw
3310  * exceptions.
3311  * Capability check has been done in comment->check_permissions(), we
3312  * don't need to do it again here.
3313  *
3314  * @package  mod_data
3315  * @category comment
3316  *
3317  * @param stdClass $comment_param {
3318  *              context  => context the context object
3319  *              courseid => int course id
3320  *              cm       => stdClass course module object
3321  *              commentarea => string comment area
3322  *              itemid      => int itemid
3323  * }
3324  * @return array
3325  */
3326 function data_comment_permissions($comment_param) {
3327     global $CFG, $DB;
3328     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3329         throw new comment_exception('invalidcommentitemid');
3330     }
3331     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3332         throw new comment_exception('invalidid', 'data');
3333     }
3334     if ($data->comments) {
3335         return array('post'=>true, 'view'=>true);
3336     } else {
3337         return array('post'=>false, 'view'=>false);
3338     }
3341 /**
3342  * Validate comment parameter before perform other comments actions
3343  *
3344  * @package  mod_data
3345  * @category comment
3346  *
3347  * @param stdClass $comment_param {
3348  *              context  => context the context object
3349  *              courseid => int course id
3350  *              cm       => stdClass course module object
3351  *              commentarea => string comment area
3352  *              itemid      => int itemid
3353  * }
3354  * @return boolean
3355  */
3356 function data_comment_validate($comment_param) {
3357     global $DB;
3358     // validate comment area
3359     if ($comment_param->commentarea != 'database_entry') {
3360         throw new comment_exception('invalidcommentarea');
3361     }
3362     // validate itemid
3363     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3364         throw new comment_exception('invalidcommentitemid');
3365     }
3366     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3367         throw new comment_exception('invalidid', 'data');
3368     }
3369     if (!$course = $DB->get_record('course', array('id'=>$data->course))) {
3370         throw new comment_exception('coursemisconf');
3371     }
3372     if (!$cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
3373         throw new comment_exception('invalidcoursemodule');
3374     }
3375     if (!$data->comments) {
3376         throw new comment_exception('commentsoff', 'data');
3377     }
3378     $context = context_module::instance($cm->id);
3380     //check if approved
3381     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3382         throw new comment_exception('notapproved', 'data');
3383     }
3385     // group access
3386     if ($record->groupid) {
3387         $groupmode = groups_get_activity_groupmode($cm, $course);
3388         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3389             if (!groups_is_member($record->groupid)) {
3390                 throw new comment_exception('notmemberofgroup');
3391             }
3392         }
3393     }
3394     // validate context id
3395     if ($context->id != $comment_param->context->id) {
3396         throw new comment_exception('invalidcontext');
3397     }
3398     // validation for comment deletion
3399     if (!empty($comment_param->commentid)) {
3400         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3401             if ($comment->commentarea != 'database_entry') {
3402                 throw new comment_exception('invalidcommentarea');
3403             }
3404             if ($comment->contextid != $comment_param->context->id) {
3405                 throw new comment_exception('invalidcontext');
3406             }
3407             if ($comment->itemid != $comment_param->itemid) {
3408                 throw new comment_exception('invalidcommentitemid');
3409             }
3410         } else {
3411             throw new comment_exception('invalidcommentid');
3412         }
3413     }
3414     return true;
3417 /**
3418  * Return a list of page types
3419  * @param string $pagetype current page type
3420  * @param stdClass $parentcontext Block's parent context
3421  * @param stdClass $currentcontext Current context of block
3422  */
3423 function data_page_type_list($pagetype, $parentcontext, $currentcontext) {
3424     $module_pagetype = array('mod-data-*'=>get_string('page-mod-data-x', 'data'));
3425     return $module_pagetype;
3428 /**
3429  * Get all of the record ids from a database activity.
3430  *
3431  * @param int    $dataid      The dataid of the database module.
3432  * @param object $selectdata  Contains an additional sql statement for the
3433  *                            where clause for group and approval fields.
3434  * @param array  $params      Parameters that coincide with the sql statement.
3435  * @return array $idarray     An array of record ids
3436  */
3437 function data_get_all_recordids($dataid, $selectdata = '', $params = null) {
3438     global $DB;
3439     $initsql = 'SELECT r.id
3440                   FROM {data_records} r
3441                  WHERE r.dataid = :dataid';
3442     if ($selectdata != '') {
3443         $initsql .= $selectdata;
3444         $params = array_merge(array('dataid' => $dataid), $params);
3445     } else {
3446         $params = array('dataid' => $dataid);
3447     }
3448     $initsql .= ' GROUP BY r.id';
3449     $initrecord = $DB->get_recordset_sql($initsql, $params);
3450     $idarray = array();
3451     foreach ($initrecord as $data) {
3452         $idarray[] = $data->id;
3453     }
3454     // Close the record set and free up resources.
3455     $initrecord->close();
3456     return $idarray;
3459 /**
3460  * Get the ids of all the records that match that advanced search criteria
3461  * This goes and loops through each criterion one at a time until it either
3462  * runs out of records or returns a subset of records.
3463  *
3464  * @param array $recordids    An array of record ids.
3465  * @param array $searcharray  Contains information for the advanced search criteria
3466  * @param int $dataid         The data id of the database.
3467  * @return array $recordids   An array of record ids.
3468  */
3469 function data_get_advance_search_ids($recordids, $searcharray, $dataid) {
3470     $searchcriteria = array_keys($searcharray);
3471     // Loop through and reduce the IDs one search criteria at a time.
3472     foreach ($searchcriteria as $key) {
3473         $recordids = data_get_recordids($key, $searcharray, $dataid, $recordids);
3474         // If we don't have anymore IDs then stop.
3475         if (!$recordids) {
3476             break;
3477         }
3478     }
3479     return $recordids;
3482 /**
3483  * Gets the record IDs given the search criteria
3484  *
3485  * @param string $alias       Record alias.
3486  * @param array $searcharray  Criteria for the search.
3487  * @param int $dataid         Data ID for the database
3488  * @param array $recordids    An array of record IDs.
3489  * @return array $nestarray   An arry of record IDs
3490  */
3491 function data_get_recordids($alias, $searcharray, $dataid, $recordids) {
3492     global $DB;
3494     $nestsearch = $searcharray[$alias];
3495     // searching for content outside of mdl_data_content
3496     if ($alias < 0) {
3497         $alias = '';
3498     }
3499     list($insql, $params) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3500     $nestselect = 'SELECT c' . $alias . '.recordid
3501                      FROM {data_content} c' . $alias . ',
3502                           {data_fields} f,
3503                           {data_records} r,
3504                           {user} u ';
3505     $nestwhere = 'WHERE u.id = r.userid
3506                     AND f.id = c' . $alias . '.fieldid
3507                     AND r.id = c' . $alias . '.recordid
3508                     AND r.dataid = :dataid
3509                     AND c' . $alias .'.recordid ' . $insql . '
3510                     AND ';
3512     $params['dataid'] = $dataid;
3513     if (count($nestsearch->params) != 0) {
3514         $params = array_merge($params, $nestsearch->params);
3515         $nestsql = $nestselect . $nestwhere . $nestsearch->sql;
3516     } else {
3517         $thing = $DB->sql_like($nestsearch->field, ':search1', false);
3518         $nestsql = $nestselect . $nestwhere . $thing . ' GROUP BY c' . $alias . '.recordid';
3519         $params['search1'] = "%$nestsearch->data%";
3520     }
3521     $nestrecords = $DB->get_recordset_sql($nestsql, $params);
3522     $nestarray = array();
3523     foreach ($nestrecords as $data) {
3524         $nestarray[] = $data->recordid;
3525     }
3526     // Close the record set and free up resources.
3527     $nestrecords->close();
3528     return $nestarray;
3531 /**
3532  * Returns an array with an sql string for advanced searches and the parameters that go with them.
3533  *
3534  * @param int $sort            DATA_*
3535  * @param stdClass $data       Data module object
3536  * @param array $recordids     An array of record IDs.
3537  * @param string $selectdata   Information for the where and select part of the sql statement.
3538  * @param string $sortorder    Additional sort parameters
3539  * @return array sqlselect     sqlselect['sql'] has the sql string, sqlselect['params'] contains an array of parameters.
3540  */
3541 function data_get_advanced_search_sql($sort, $data, $recordids, $selectdata, $sortorder) {
3542     global $DB;
3543     if ($sort == 0) {
3544         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname
3545                         FROM {data_content} c,
3546                              {data_records} r,
3547                              {user} u ';
3548         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname ';
3549     } else {
3550         // Sorting through 'Other' criteria
3551         if ($sort <= 0) {
3552             switch ($sort) {
3553                 case DATA_LASTNAME:
3554                     $sortcontentfull = "u.lastname";
3555                     break;
3556                 case DATA_FIRSTNAME:
3557                     $sortcontentfull = "u.firstname";
3558                     break;
3559                 case DATA_APPROVED:
3560                     $sortcontentfull = "r.approved";
3561                     break;
3562                 case DATA_TIMEMODIFIED:
3563                     $sortcontentfull = "r.timemodified";
3564                     break;
3565                 case DATA_TIMEADDED:
3566                 default:
3567                     $sortcontentfull = "r.timecreated";
3568             }
3569         } else {
3570             $sortfield = data_get_field_from_id($sort, $data);
3571             $sortcontent = $DB->sql_compare_text('c.' . $sortfield->get_sort_field());
3572             $sortcontentfull = $sortfield->get_sort_sql($sortcontent);
3573         }
3575         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' . $sortcontentfull . '
3576                               AS sortorder
3577                             FROM {data_content} c,
3578                                  {data_records} r,
3579                                  {user} u ';
3580         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' .$sortcontentfull;
3581     }
3583     // Default to a standard Where statement if $selectdata is empty.
3584     if ($selectdata == '') {
3585         $selectdata = 'WHERE c.recordid = r.id
3586                          AND r.dataid = :dataid
3587                          AND r.userid = u.id ';
3588     }
3590     // Find the field we are sorting on
3591     if ($sort > 0 or data_get_field_from_id($sort, $data)) {
3592         $selectdata .= ' AND c.fieldid = :sort';
3593     }
3595     // If there are no record IDs then return an sql statment that will return no rows.
3596     if (count($recordids) != 0) {
3597         list($insql, $inparam) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3598     } else {
3599         list($insql, $inparam) = $DB->get_in_or_equal(array('-1'), SQL_PARAMS_NAMED);
3600     }
3601     $nestfromsql = $selectdata . ' AND c.recordid ' . $insql . $groupsql;
3602     $sqlselect['sql'] = "$nestselectsql $nestfromsql $sortorder";
3603     $sqlselect['params'] = $inparam;
3604     return $sqlselect;
3607 /**
3608  * Checks to see if the user has permission to delete the preset.
3609  * @param stdClass $context  Context object.
3610  * @param stdClass $preset  The preset object that we are checking for deletion.
3611  * @return bool  Returns true if the user can delete, otherwise false.
3612  */
3613 function data_user_can_delete_preset($context, $preset) {
3614     global $USER;
3616     if (has_capability('mod/data:manageuserpresets', $context)) {
3617         return true;
3618     } else {
3619         $candelete = false;
3620         if ($preset->userid == $USER->id) {
3621             $candelete = true;
3622         }
3623         return $candelete;
3624     }