e7b6ccd380f0c0ff502670638137dc977a7c3097
[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 = '';
140         $this->field->required = false;
142         return true;
143     }
145     /**
146      * Set up the field object according to data in an object.  Now is the time to clean it!
147      *
148      * @return bool
149      */
150     function define_field($data) {
151         $this->field->type        = $this->type;
152         $this->field->dataid      = $this->data->id;
154         $this->field->name        = trim($data->name);
155         $this->field->description = trim($data->description);
156         $this->field->required    = !empty($data->required) ? 1 : 0;
158         if (isset($data->param1)) {
159             $this->field->param1 = trim($data->param1);
160         }
161         if (isset($data->param2)) {
162             $this->field->param2 = trim($data->param2);
163         }
164         if (isset($data->param3)) {
165             $this->field->param3 = trim($data->param3);
166         }
167         if (isset($data->param4)) {
168             $this->field->param4 = trim($data->param4);
169         }
170         if (isset($data->param5)) {
171             $this->field->param5 = trim($data->param5);
172         }
174         return true;
175     }
177     /**
178      * Insert a new field in the database
179      * We assume the field object is already defined as $this->field
180      *
181      * @global object
182      * @return bool
183      */
184     function insert_field() {
185         global $DB, $OUTPUT;
187         if (empty($this->field)) {
188             echo $OUTPUT->notification('Programmer error: Field has not been defined yet!  See define_field()');
189             return false;
190         }
192         $this->field->id = $DB->insert_record('data_fields',$this->field);
194         // Trigger an event for creating this field.
195         $event = \mod_data\event\field_created::create(array(
196             'objectid' => $this->field->id,
197             'context' => $this->context,
198             'other' => array(
199                 'fieldname' => $this->field->name,
200                 'dataid' => $this->data->id
201             )
202         ));
203         $event->trigger();
205         return true;
206     }
209     /**
210      * Update a field in the database
211      *
212      * @global object
213      * @return bool
214      */
215     function update_field() {
216         global $DB;
218         $DB->update_record('data_fields', $this->field);
220         // Trigger an event for updating this field.
221         $event = \mod_data\event\field_updated::create(array(
222             'objectid' => $this->field->id,
223             'context' => $this->context,
224             'other' => array(
225                 'fieldname' => $this->field->name,
226                 'dataid' => $this->data->id
227             )
228         ));
229         $event->trigger();
231         return true;
232     }
234     /**
235      * Delete a field completely
236      *
237      * @global object
238      * @return bool
239      */
240     function delete_field() {
241         global $DB;
243         if (!empty($this->field->id)) {
244             // Get the field before we delete it.
245             $field = $DB->get_record('data_fields', array('id' => $this->field->id));
247             $this->delete_content();
248             $DB->delete_records('data_fields', array('id'=>$this->field->id));
250             // Trigger an event for deleting this field.
251             $event = \mod_data\event\field_deleted::create(array(
252                 'objectid' => $this->field->id,
253                 'context' => $this->context,
254                 'other' => array(
255                     'fieldname' => $this->field->name,
256                     'dataid' => $this->data->id
257                  )
258             ));
259             $event->add_record_snapshot('data_fields', $field);
260             $event->trigger();
261         }
263         return true;
264     }
266     /**
267      * Print the relevant form element in the ADD template for this field
268      *
269      * @global object
270      * @param int $recordid
271      * @return string
272      */
273     function display_add_field($recordid=0, $formdata=null) {
274         global $DB, $OUTPUT;
276         if ($formdata) {
277             $fieldname = 'field_' . $this->field->id;
278             $content = $formdata->$fieldname;
279         } else if ($recordid) {
280             $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
281         } else {
282             $content = '';
283         }
285         // beware get_field returns false for new, empty records MDL-18567
286         if ($content===false) {
287             $content='';
288         }
290         $str = '<div title="' . s($this->field->description) . '">';
291         $str .= '<label for="field_'.$this->field->id.'"><span class="accesshide">'.$this->field->name.'</span>';
292         if ($this->field->required) {
293             $image = html_writer::img($OUTPUT->pix_url('req'), get_string('requiredelement', 'form'),
294                                      array('class' => 'req', 'title' => get_string('requiredelement', 'form')));
295             $str .= html_writer::div($image, 'inline-req');
296         }
297         $str .= '</label><input class="basefieldinput mod-data-input" type="text" name="field_'.$this->field->id.'"';
298         $str .= ' id="field_' . $this->field->id . '" value="'.s($content).'" />';
299         $str .= '</div>';
301         return $str;
302     }
304     /**
305      * Print the relevant form element to define the attributes for this field
306      * viewable by teachers only.
307      *
308      * @global object
309      * @global object
310      * @return void Output is echo'd
311      */
312     function display_edit_field() {
313         global $CFG, $DB, $OUTPUT;
315         if (empty($this->field)) {   // No field has been defined yet, try and make one
316             $this->define_default_field();
317         }
318         echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
320         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
321         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
322         if (empty($this->field->id)) {
323             echo '<input type="hidden" name="mode" value="add" />'."\n";
324             $savebutton = get_string('add');
325         } else {
326             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
327             echo '<input type="hidden" name="mode" value="update" />'."\n";
328             $savebutton = get_string('savechanges');
329         }
330         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
331         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
333         echo $OUTPUT->heading($this->name(), 3);
335         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
337         echo '<div class="mdl-align">';
338         echo '<input type="submit" value="'.$savebutton.'" />'."\n";
339         echo '<input type="submit" name="cancel" value="'.get_string('cancel').'" />'."\n";
340         echo '</div>';
342         echo '</form>';
344         echo $OUTPUT->box_end();
345     }
347     /**
348      * Display the content of the field in browse mode
349      *
350      * @global object
351      * @param int $recordid
352      * @param object $template
353      * @return bool|string
354      */
355     function display_browse_field($recordid, $template) {
356         global $DB;
358         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
359             if (isset($content->content)) {
360                 $options = new stdClass();
361                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
362                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
363                     //$content->content1 = FORMAT_HTML;
364                     $options->filter=false;
365                 }
366                 $options->para = false;
367                 $str = format_text($content->content, $content->content1, $options);
368             } else {
369                 $str = '';
370             }
371             return $str;
372         }
373         return false;
374     }
376     /**
377      * Update the content of one data field in the data_content table
378      * @global object
379      * @param int $recordid
380      * @param mixed $value
381      * @param string $name
382      * @return bool
383      */
384     function update_content($recordid, $value, $name=''){
385         global $DB;
387         $content = new stdClass();
388         $content->fieldid = $this->field->id;
389         $content->recordid = $recordid;
390         $content->content = clean_param($value, PARAM_NOTAGS);
392         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
393             $content->id = $oldcontent->id;
394             return $DB->update_record('data_content', $content);
395         } else {
396             return $DB->insert_record('data_content', $content);
397         }
398     }
400     /**
401      * Delete all content associated with the field
402      *
403      * @global object
404      * @param int $recordid
405      * @return bool
406      */
407     function delete_content($recordid=0) {
408         global $DB;
410         if ($recordid) {
411             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
412         } else {
413             $conditions = array('fieldid'=>$this->field->id);
414         }
416         $rs = $DB->get_recordset('data_content', $conditions);
417         if ($rs->valid()) {
418             $fs = get_file_storage();
419             foreach ($rs as $content) {
420                 $fs->delete_area_files($this->context->id, 'mod_data', 'content', $content->id);
421             }
422         }
423         $rs->close();
425         return $DB->delete_records('data_content', $conditions);
426     }
428     /**
429      * Check if a field from an add form is empty
430      *
431      * @param mixed $value
432      * @param mixed $name
433      * @return bool
434      */
435     function notemptyfield($value, $name) {
436         return !empty($value);
437     }
439     /**
440      * Just in case a field needs to print something before the whole form
441      */
442     function print_before_form() {
443     }
445     /**
446      * Just in case a field needs to print something after the whole form
447      */
448     function print_after_form() {
449     }
452     /**
453      * Returns the sortable field for the content. By default, it's just content
454      * but for some plugins, it could be content 1 - content4
455      *
456      * @return string
457      */
458     function get_sort_field() {
459         return 'content';
460     }
462     /**
463      * Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
464      *
465      * @param string $fieldname
466      * @return string $fieldname
467      */
468     function get_sort_sql($fieldname) {
469         return $fieldname;
470     }
472     /**
473      * Returns the name/type of the field
474      *
475      * @return string
476      */
477     function name() {
478         return get_string('name'.$this->type, 'data');
479     }
481     /**
482      * Prints the respective type icon
483      *
484      * @global object
485      * @return string
486      */
487     function image() {
488         global $OUTPUT;
490         $params = array('d'=>$this->data->id, 'fid'=>$this->field->id, 'mode'=>'display', 'sesskey'=>sesskey());
491         $link = new moodle_url('/mod/data/field.php', $params);
492         $str = '<a href="'.$link->out().'">';
493         $str .= '<img src="'.$OUTPUT->pix_url('field/'.$this->type, 'data') . '" ';
494         $str .= 'height="'.$this->iconheight.'" width="'.$this->iconwidth.'" alt="'.$this->type.'" title="'.$this->type.'" /></a>';
495         return $str;
496     }
498     /**
499      * Per default, it is assumed that fields support text exporting.
500      * Override this (return false) on fields not supporting text exporting.
501      *
502      * @return bool true
503      */
504     function text_export_supported() {
505         return true;
506     }
508     /**
509      * Per default, return the record's text value only from the "content" field.
510      * Override this in fields class if necesarry.
511      *
512      * @param string $record
513      * @return string
514      */
515     function export_text_value($record) {
516         if ($this->text_export_supported()) {
517             return $record->content;
518         }
519     }
521     /**
522      * @param string $relativepath
523      * @return bool false
524      */
525     function file_ok($relativepath) {
526         return false;
527     }
531 /**
532  * Given a template and a dataid, generate a default case template
533  *
534  * @global object
535  * @param object $data
536  * @param string template [addtemplate, singletemplate, listtempalte, rsstemplate]
537  * @param int $recordid
538  * @param bool $form
539  * @param bool $update
540  * @return bool|string
541  */
542 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
543     global $DB;
545     if (!$data && !$template) {
546         return false;
547     }
548     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
549         return '';
550     }
552     // get all the fields for that database
553     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
555         $table = new html_table();
556         $table->attributes['class'] = 'mod-data-default-template ##approvalstatus##';
557         $table->colclasses = array('template-field', 'template-token');
558         $table->data = array();
559         foreach ($fields as $field) {
560             if ($form) {   // Print forms instead of data
561                 $fieldobj = data_get_field($field, $data);
562                 $token = $fieldobj->display_add_field($recordid, null);
563             } else {           // Just print the tag
564                 $token = '[['.$field->name.']]';
565             }
566             $table->data[] = array(
567                 $field->name.': ',
568                 $token
569             );
570         }
571         if ($template == 'listtemplate') {
572             $cell = new html_table_cell('##edit##  ##more##  ##delete##  ##approve##  ##disapprove##  ##export##');
573             $cell->colspan = 2;
574             $cell->attributes['class'] = 'controls';
575             $table->data[] = new html_table_row(array($cell));
576         } else if ($template == 'singletemplate') {
577             $cell = new html_table_cell('##edit##  ##delete##  ##approve##  ##disapprove##  ##export##');
578             $cell->colspan = 2;
579             $cell->attributes['class'] = 'controls';
580             $table->data[] = new html_table_row(array($cell));
581         } else if ($template == 'asearchtemplate') {
582             $row = new html_table_row(array(get_string('authorfirstname', 'data').': ', '##firstname##'));
583             $row->attributes['class'] = 'searchcontrols';
584             $table->data[] = $row;
585             $row = new html_table_row(array(get_string('authorlastname', 'data').': ', '##lastname##'));
586             $row->attributes['class'] = 'searchcontrols';
587             $table->data[] = $row;
588         }
590         $str = '';
591         if ($template == 'listtemplate'){
592             $str .= '##delcheck##';
593             $str .= html_writer::empty_tag('br');
594         }
596         $str .= html_writer::start_tag('div', array('class' => 'defaulttemplate'));
597         $str .= html_writer::table($table);
598         $str .= html_writer::end_tag('div');
599         if ($template == 'listtemplate'){
600             $str .= html_writer::empty_tag('hr');
601         }
603         if ($update) {
604             $newdata = new stdClass();
605             $newdata->id = $data->id;
606             $newdata->{$template} = $str;
607             $DB->update_record('data', $newdata);
608             $data->{$template} = $str;
609         }
611         return $str;
612     }
616 /**
617  * Search for a field name and replaces it with another one in all the
618  * form templates. Set $newfieldname as '' if you want to delete the
619  * field from the form.
620  *
621  * @global object
622  * @param object $data
623  * @param string $searchfieldname
624  * @param string $newfieldname
625  * @return bool
626  */
627 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
628     global $DB;
630     if (!empty($newfieldname)) {
631         $prestring = '[[';
632         $poststring = ']]';
633         $idpart = '#id';
635     } else {
636         $prestring = '';
637         $poststring = '';
638         $idpart = '';
639     }
641     $newdata = new stdClass();
642     $newdata->id = $data->id;
643     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
644             $prestring.$newfieldname.$poststring, $data->singletemplate);
646     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
647             $prestring.$newfieldname.$poststring, $data->listtemplate);
649     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
650             $prestring.$newfieldname.$poststring, $data->addtemplate);
652     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
653             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
655     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
656             $prestring.$newfieldname.$poststring, $data->rsstemplate);
658     return $DB->update_record('data', $newdata);
662 /**
663  * Appends a new field at the end of the form template.
664  *
665  * @global object
666  * @param object $data
667  * @param string $newfieldname
668  */
669 function data_append_new_field_to_templates($data, $newfieldname) {
670     global $DB;
672     $newdata = new stdClass();
673     $newdata->id = $data->id;
674     $change = false;
676     if (!empty($data->singletemplate)) {
677         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
678         $change = true;
679     }
680     if (!empty($data->addtemplate)) {
681         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
682         $change = true;
683     }
684     if (!empty($data->rsstemplate)) {
685         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
686         $change = true;
687     }
688     if ($change) {
689         $DB->update_record('data', $newdata);
690     }
694 /**
695  * given a field name
696  * this function creates an instance of the particular subfield class
697  *
698  * @global object
699  * @param string $name
700  * @param object $data
701  * @return object|bool
702  */
703 function data_get_field_from_name($name, $data){
704     global $DB;
706     $field = $DB->get_record('data_fields', array('name'=>$name, 'dataid'=>$data->id));
708     if ($field) {
709         return data_get_field($field, $data);
710     } else {
711         return false;
712     }
715 /**
716  * given a field id
717  * this function creates an instance of the particular subfield class
718  *
719  * @global object
720  * @param int $fieldid
721  * @param object $data
722  * @return bool|object
723  */
724 function data_get_field_from_id($fieldid, $data){
725     global $DB;
727     $field = $DB->get_record('data_fields', array('id'=>$fieldid, 'dataid'=>$data->id));
729     if ($field) {
730         return data_get_field($field, $data);
731     } else {
732         return false;
733     }
736 /**
737  * given a field id
738  * this function creates an instance of the particular subfield class
739  *
740  * @global object
741  * @param string $type
742  * @param object $data
743  * @return object
744  */
745 function data_get_field_new($type, $data) {
746     global $CFG;
748     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
749     $newfield = 'data_field_'.$type;
750     $newfield = new $newfield(0, $data);
751     return $newfield;
754 /**
755  * returns a subclass field object given a record of the field, used to
756  * invoke plugin methods
757  * input: $param $field - record from db
758  *
759  * @global object
760  * @param object $field
761  * @param object $data
762  * @param object $cm
763  * @return object
764  */
765 function data_get_field($field, $data, $cm=null) {
766     global $CFG;
768     if ($field) {
769         require_once('field/'.$field->type.'/field.class.php');
770         $newfield = 'data_field_'.$field->type;
771         $newfield = new $newfield($field, $data, $cm);
772         return $newfield;
773     }
777 /**
778  * Given record object (or id), returns true if the record belongs to the current user
779  *
780  * @global object
781  * @global object
782  * @param mixed $record record object or id
783  * @return bool
784  */
785 function data_isowner($record) {
786     global $USER, $DB;
788     if (!isloggedin()) { // perf shortcut
789         return false;
790     }
792     if (!is_object($record)) {
793         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
794             return false;
795         }
796     }
798     return ($record->userid == $USER->id);
801 /**
802  * has a user reached the max number of entries?
803  *
804  * @param object $data
805  * @return bool
806  */
807 function data_atmaxentries($data){
808     if (!$data->maxentries){
809         return false;
811     } else {
812         return (data_numentries($data) >= $data->maxentries);
813     }
816 /**
817  * returns the number of entries already made by this user
818  *
819  * @global object
820  * @global object
821  * @param object $data
822  * @return int
823  */
824 function data_numentries($data){
825     global $USER, $DB;
826     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
827     return $DB->count_records_sql($sql, array($data->id, $USER->id));
830 /**
831  * function that takes in a dataid and adds a record
832  * this is used everytime an add template is submitted
833  *
834  * @global object
835  * @global object
836  * @param object $data
837  * @param int $groupid
838  * @return bool
839  */
840 function data_add_record($data, $groupid=0){
841     global $USER, $DB;
843     $cm = get_coursemodule_from_instance('data', $data->id);
844     $context = context_module::instance($cm->id);
846     $record = new stdClass();
847     $record->userid = $USER->id;
848     $record->dataid = $data->id;
849     $record->groupid = $groupid;
850     $record->timecreated = $record->timemodified = time();
851     if (has_capability('mod/data:approve', $context)) {
852         $record->approved = 1;
853     } else {
854         $record->approved = 0;
855     }
856     $record->id = $DB->insert_record('data_records', $record);
858     // Trigger an event for creating this record.
859     $event = \mod_data\event\record_created::create(array(
860         'objectid' => $record->id,
861         'context' => $context,
862         'other' => array(
863             'dataid' => $data->id
864         )
865     ));
866     $event->trigger();
868     return $record->id;
871 /**
872  * check the multple existence any tag in a template
873  *
874  * check to see if there are 2 or more of the same tag being used.
875  *
876  * @global object
877  * @param int $dataid,
878  * @param string $template
879  * @return bool
880  */
881 function data_tags_check($dataid, $template) {
882     global $DB, $OUTPUT;
884     // first get all the possible tags
885     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
886     // then we generate strings to replace
887     $tagsok = true; // let's be optimistic
888     foreach ($fields as $field){
889         $pattern="/\[\[" . preg_quote($field->name, '/') . "\]\]/i";
890         if (preg_match_all($pattern, $template, $dummy)>1){
891             $tagsok = false;
892             echo $OUTPUT->notification('[['.$field->name.']] - '.get_string('multipletags','data'));
893         }
894     }
895     // else return true
896     return $tagsok;
899 /**
900  * Adds an instance of a data
901  *
902  * @param stdClass $data
903  * @param mod_data_mod_form $mform
904  * @return int intance id
905  */
906 function data_add_instance($data, $mform = null) {
907     global $DB;
909     if (empty($data->assessed)) {
910         $data->assessed = 0;
911     }
913     $data->timemodified = time();
915     $data->id = $DB->insert_record('data', $data);
917     data_grade_item_update($data);
919     return $data->id;
922 /**
923  * updates an instance of a data
924  *
925  * @global object
926  * @param object $data
927  * @return bool
928  */
929 function data_update_instance($data) {
930     global $DB, $OUTPUT;
932     $data->timemodified = time();
933     $data->id           = $data->instance;
935     if (empty($data->assessed)) {
936         $data->assessed = 0;
937     }
939     if (empty($data->ratingtime) or empty($data->assessed)) {
940         $data->assesstimestart  = 0;
941         $data->assesstimefinish = 0;
942     }
944     if (empty($data->notification)) {
945         $data->notification = 0;
946     }
948     $DB->update_record('data', $data);
950     data_grade_item_update($data);
952     return true;
956 /**
957  * deletes an instance of a data
958  *
959  * @global object
960  * @param int $id
961  * @return bool
962  */
963 function data_delete_instance($id) {    // takes the dataid
964     global $DB, $CFG;
966     if (!$data = $DB->get_record('data', array('id'=>$id))) {
967         return false;
968     }
970     $cm = get_coursemodule_from_instance('data', $data->id);
971     $context = context_module::instance($cm->id);
973 /// Delete all the associated information
975     // files
976     $fs = get_file_storage();
977     $fs->delete_area_files($context->id, 'mod_data');
979     // get all the records in this data
980     $sql = "SELECT r.id
981               FROM {data_records} r
982              WHERE r.dataid = ?";
984     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
986     // delete all the records and fields
987     $DB->delete_records('data_records', array('dataid'=>$id));
988     $DB->delete_records('data_fields', array('dataid'=>$id));
990     // Delete the instance itself
991     $result = $DB->delete_records('data', array('id'=>$id));
993     // cleanup gradebook
994     data_grade_item_delete($data);
996     return $result;
999 /**
1000  * returns a summary of data activity of this user
1001  *
1002  * @global object
1003  * @param object $course
1004  * @param object $user
1005  * @param object $mod
1006  * @param object $data
1007  * @return object|null
1008  */
1009 function data_user_outline($course, $user, $mod, $data) {
1010     global $DB, $CFG;
1011     require_once("$CFG->libdir/gradelib.php");
1013     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1014     if (empty($grades->items[0]->grades)) {
1015         $grade = false;
1016     } else {
1017         $grade = reset($grades->items[0]->grades);
1018     }
1021     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
1022         $result = new stdClass();
1023         $result->info = get_string('numrecords', 'data', $countrecords);
1024         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
1025                                               WHERE dataid = ? AND userid = ?
1026                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
1027         $result->time = $lastrecord->timemodified;
1028         if ($grade) {
1029             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1030         }
1031         return $result;
1032     } else if ($grade) {
1033         $result = new stdClass();
1034         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1036         //datesubmitted == time created. dategraded == time modified or time overridden
1037         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1038         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1039         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1040             $result->time = $grade->dategraded;
1041         } else {
1042             $result->time = $grade->datesubmitted;
1043         }
1045         return $result;
1046     }
1047     return NULL;
1050 /**
1051  * Prints all the records uploaded by this user
1052  *
1053  * @global object
1054  * @param object $course
1055  * @param object $user
1056  * @param object $mod
1057  * @param object $data
1058  */
1059 function data_user_complete($course, $user, $mod, $data) {
1060     global $DB, $CFG, $OUTPUT;
1061     require_once("$CFG->libdir/gradelib.php");
1063     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1064     if (!empty($grades->items[0]->grades)) {
1065         $grade = reset($grades->items[0]->grades);
1066         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1067         if ($grade->str_feedback) {
1068             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1069         }
1070     }
1072     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1073         data_print_template('singletemplate', $records, $data);
1074     }
1077 /**
1078  * Return grade for given user or all users.
1079  *
1080  * @global object
1081  * @param object $data
1082  * @param int $userid optional user id, 0 means all users
1083  * @return array array of grades, false if none
1084  */
1085 function data_get_user_grades($data, $userid=0) {
1086     global $CFG;
1088     require_once($CFG->dirroot.'/rating/lib.php');
1090     $ratingoptions = new stdClass;
1091     $ratingoptions->component = 'mod_data';
1092     $ratingoptions->ratingarea = 'entry';
1093     $ratingoptions->modulename = 'data';
1094     $ratingoptions->moduleid   = $data->id;
1096     $ratingoptions->userid = $userid;
1097     $ratingoptions->aggregationmethod = $data->assessed;
1098     $ratingoptions->scaleid = $data->scale;
1099     $ratingoptions->itemtable = 'data_records';
1100     $ratingoptions->itemtableusercolumn = 'userid';
1102     $rm = new rating_manager();
1103     return $rm->get_user_grades($ratingoptions);
1106 /**
1107  * Update activity grades
1108  *
1109  * @category grade
1110  * @param object $data
1111  * @param int $userid specific user only, 0 means all
1112  * @param bool $nullifnone
1113  */
1114 function data_update_grades($data, $userid=0, $nullifnone=true) {
1115     global $CFG, $DB;
1116     require_once($CFG->libdir.'/gradelib.php');
1118     if (!$data->assessed) {
1119         data_grade_item_update($data);
1121     } else if ($grades = data_get_user_grades($data, $userid)) {
1122         data_grade_item_update($data, $grades);
1124     } else if ($userid and $nullifnone) {
1125         $grade = new stdClass();
1126         $grade->userid   = $userid;
1127         $grade->rawgrade = NULL;
1128         data_grade_item_update($data, $grade);
1130     } else {
1131         data_grade_item_update($data);
1132     }
1135 /**
1136  * Update/create grade item for given data
1137  *
1138  * @category grade
1139  * @param stdClass $data A database instance with extra cmidnumber property
1140  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1141  * @return object grade_item
1142  */
1143 function data_grade_item_update($data, $grades=NULL) {
1144     global $CFG;
1145     require_once($CFG->libdir.'/gradelib.php');
1147     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1149     if (!$data->assessed or $data->scale == 0) {
1150         $params['gradetype'] = GRADE_TYPE_NONE;
1152     } else if ($data->scale > 0) {
1153         $params['gradetype'] = GRADE_TYPE_VALUE;
1154         $params['grademax']  = $data->scale;
1155         $params['grademin']  = 0;
1157     } else if ($data->scale < 0) {
1158         $params['gradetype'] = GRADE_TYPE_SCALE;
1159         $params['scaleid']   = -$data->scale;
1160     }
1162     if ($grades  === 'reset') {
1163         $params['reset'] = true;
1164         $grades = NULL;
1165     }
1167     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1170 /**
1171  * Delete grade item for given data
1172  *
1173  * @category grade
1174  * @param object $data object
1175  * @return object grade_item
1176  */
1177 function data_grade_item_delete($data) {
1178     global $CFG;
1179     require_once($CFG->libdir.'/gradelib.php');
1181     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1184 // junk functions
1185 /**
1186  * takes a list of records, the current data, a search string,
1187  * and mode to display prints the translated template
1188  *
1189  * @global object
1190  * @global object
1191  * @param string $template
1192  * @param array $records
1193  * @param object $data
1194  * @param string $search
1195  * @param int $page
1196  * @param bool $return
1197  * @param object $jumpurl a moodle_url by which to jump back to the record list (can be null)
1198  * @return mixed
1199  */
1200 function data_print_template($template, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null) {
1201     global $CFG, $DB, $OUTPUT;
1203     $cm = get_coursemodule_from_instance('data', $data->id);
1204     $context = context_module::instance($cm->id);
1206     static $fields = NULL;
1207     static $isteacher;
1208     static $dataid = NULL;
1210     if (empty($dataid)) {
1211         $dataid = $data->id;
1212     } else if ($dataid != $data->id) {
1213         $fields = NULL;
1214     }
1216     if (empty($fields)) {
1217         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1218         foreach ($fieldrecords as $fieldrecord) {
1219             $fields[]= data_get_field($fieldrecord, $data);
1220         }
1221         $isteacher = has_capability('mod/data:managetemplates', $context);
1222     }
1224     if (empty($records)) {
1225         return;
1226     }
1228     if (!$jumpurl) {
1229         $jumpurl = new moodle_url('/mod/data/view.php', array('d' => $data->id));
1230     }
1231     $jumpurl = new moodle_url($jumpurl, array('page' => $page, 'sesskey' => sesskey()));
1233     // Check whether this activity is read-only at present
1234     $readonly = data_in_readonly_period($data);
1236     foreach ($records as $record) {   // Might be just one for the single template
1238     // Replacing tags
1239         $patterns = array();
1240         $replacement = array();
1242     // Then we generate strings to replace for normal tags
1243         foreach ($fields as $field) {
1244             $patterns[]='[['.$field->field->name.']]';
1245             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1246         }
1248         $canmanageentries = has_capability('mod/data:manageentries', $context);
1250     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1251         $patterns[]='##edit##';
1252         $patterns[]='##delete##';
1253         if ($canmanageentries || (!$readonly && data_isowner($record->id))) {
1254             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1255                              .$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>';
1256             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1257                              .$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>';
1258         } else {
1259             $replacement[] = '';
1260             $replacement[] = '';
1261         }
1263         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1264         if ($search) {
1265             $moreurl .= '&amp;filter=1';
1266         }
1267         $patterns[]='##more##';
1268         $replacement[] = '<a href="'.$moreurl.'"><img src="'.$OUTPUT->pix_url('t/preview').
1269                         '" class="iconsmall" alt="'.get_string('more', 'data').'" title="'.get_string('more', 'data').
1270                         '" /></a>';
1272         $patterns[]='##moreurl##';
1273         $replacement[] = $moreurl;
1275         $patterns[]='##delcheck##';
1276         if ($canmanageentries) {
1277             $replacement[] = html_writer::checkbox('delcheck[]', $record->id, false, '', array('class' => 'recordcheckbox'));
1278         } else {
1279             $replacement[] = '';
1280         }
1282         $patterns[]='##user##';
1283         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1284                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1286         $patterns[] = '##userpicture##';
1287         $ruser = user_picture::unalias($record, null, 'userid');
1288         $replacement[] = $OUTPUT->user_picture($ruser, array('courseid' => $data->course));
1290         $patterns[]='##export##';
1292         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1293             && ((has_capability('mod/data:exportentry', $context)
1294                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1295             require_once($CFG->libdir . '/portfoliolib.php');
1296             $button = new portfolio_add_button();
1297             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), 'mod_data');
1298             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1299             $button->set_formats($formats);
1300             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1301         } else {
1302             $replacement[] = '';
1303         }
1305         $patterns[] = '##timeadded##';
1306         $replacement[] = userdate($record->timecreated);
1308         $patterns[] = '##timemodified##';
1309         $replacement [] = userdate($record->timemodified);
1311         $patterns[]='##approve##';
1312         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)) {
1313             $approveurl = new moodle_url($jumpurl, array('approve' => $record->id));
1314             $approveicon = new pix_icon('t/approve', get_string('approve', 'data'), '', array('class' => 'iconsmall'));
1315             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($approveurl, $approveicon),
1316                     array('class' => 'approve'));
1317         } else {
1318             $replacement[] = '';
1319         }
1321         $patterns[]='##disapprove##';
1322         if (has_capability('mod/data:approve', $context) && ($data->approval) && ($record->approved)) {
1323             $disapproveurl = new moodle_url($jumpurl, array('disapprove' => $record->id));
1324             $disapproveicon = new pix_icon('t/block', get_string('disapprove', 'data'), '', array('class' => 'iconsmall'));
1325             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($disapproveurl, $disapproveicon),
1326                     array('class' => 'disapprove'));
1327         } else {
1328             $replacement[] = '';
1329         }
1331         $patterns[] = '##approvalstatus##';
1332         if (!$data->approval) {
1333             $replacement[] = '';
1334         } else if ($record->approved) {
1335             $replacement[] = 'approved';
1336         } else {
1337             $replacement[] = 'notapproved';
1338         }
1340         $patterns[]='##comments##';
1341         if (($template == 'listtemplate') && ($data->comments)) {
1343             if (!empty($CFG->usecomments)) {
1344                 require_once($CFG->dirroot  . '/comment/lib.php');
1345                 list($context, $course, $cm) = get_context_info_array($context->id);
1346                 $cmt = new stdClass();
1347                 $cmt->context = $context;
1348                 $cmt->course  = $course;
1349                 $cmt->cm      = $cm;
1350                 $cmt->area    = 'database_entry';
1351                 $cmt->itemid  = $record->id;
1352                 $cmt->showcount = true;
1353                 $cmt->component = 'mod_data';
1354                 $comment = new comment($cmt);
1355                 $replacement[] = $comment->output(true);
1356             }
1357         } else {
1358             $replacement[] = '';
1359         }
1361         // actual replacement of the tags
1362         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1364         // no more html formatting and filtering - see MDL-6635
1365         if ($return) {
1366             return $newtext;
1367         } else {
1368             echo $newtext;
1370             // hack alert - return is always false in singletemplate anyway ;-)
1371             /**********************************
1372              *    Printing Ratings Form       *
1373              *********************************/
1374             if ($template == 'singletemplate') {    //prints ratings options
1375                 data_print_ratings($data, $record);
1376             }
1378             /**********************************
1379              *    Printing Comments Form       *
1380              *********************************/
1381             if (($template == 'singletemplate') && ($data->comments)) {
1382                 if (!empty($CFG->usecomments)) {
1383                     require_once($CFG->dirroot . '/comment/lib.php');
1384                     list($context, $course, $cm) = get_context_info_array($context->id);
1385                     $cmt = new stdClass();
1386                     $cmt->context = $context;
1387                     $cmt->course  = $course;
1388                     $cmt->cm      = $cm;
1389                     $cmt->area    = 'database_entry';
1390                     $cmt->itemid  = $record->id;
1391                     $cmt->showcount = true;
1392                     $cmt->component = 'mod_data';
1393                     $comment = new comment($cmt);
1394                     $comment->output(false);
1395                 }
1396             }
1397         }
1398     }
1401 /**
1402  * Return rating related permissions
1403  *
1404  * @param string $contextid the context id
1405  * @param string $component the component to get rating permissions for
1406  * @param string $ratingarea the rating area to get permissions for
1407  * @return array an associative array of the user's rating permissions
1408  */
1409 function data_rating_permissions($contextid, $component, $ratingarea) {
1410     $context = context::instance_by_id($contextid, MUST_EXIST);
1411     if ($component != 'mod_data' || $ratingarea != 'entry') {
1412         return null;
1413     }
1414     return array(
1415         'view'    => has_capability('mod/data:viewrating',$context),
1416         'viewany' => has_capability('mod/data:viewanyrating',$context),
1417         'viewall' => has_capability('mod/data:viewallratings',$context),
1418         'rate'    => has_capability('mod/data:rate',$context)
1419     );
1422 /**
1423  * Validates a submitted rating
1424  * @param array $params submitted data
1425  *            context => object the context in which the rated items exists [required]
1426  *            itemid => int the ID of the object being rated
1427  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1428  *            rating => int the submitted rating
1429  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1430  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1431  * @return boolean true if the rating is valid. Will throw rating_exception if not
1432  */
1433 function data_rating_validate($params) {
1434     global $DB, $USER;
1436     // Check the component is mod_data
1437     if ($params['component'] != 'mod_data') {
1438         throw new rating_exception('invalidcomponent');
1439     }
1441     // Check the ratingarea is entry (the only rating area in data module)
1442     if ($params['ratingarea'] != 'entry') {
1443         throw new rating_exception('invalidratingarea');
1444     }
1446     // Check the rateduserid is not the current user .. you can't rate your own entries
1447     if ($params['rateduserid'] == $USER->id) {
1448         throw new rating_exception('nopermissiontorate');
1449     }
1451     $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
1452                   FROM {data_records} r
1453                   JOIN {data} d ON r.dataid = d.id
1454                  WHERE r.id = :itemid";
1455     $dataparams = array('itemid'=>$params['itemid']);
1456     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1457         //item doesn't exist
1458         throw new rating_exception('invaliditemid');
1459     }
1461     if ($info->scale != $params['scaleid']) {
1462         //the scale being submitted doesnt match the one in the database
1463         throw new rating_exception('invalidscaleid');
1464     }
1466     //check that the submitted rating is valid for the scale
1468     // lower limit
1469     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1470         throw new rating_exception('invalidnum');
1471     }
1473     // upper limit
1474     if ($info->scale < 0) {
1475         //its a custom scale
1476         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1477         if ($scalerecord) {
1478             $scalearray = explode(',', $scalerecord->scale);
1479             if ($params['rating'] > count($scalearray)) {
1480                 throw new rating_exception('invalidnum');
1481             }
1482         } else {
1483             throw new rating_exception('invalidscaleid');
1484         }
1485     } else if ($params['rating'] > $info->scale) {
1486         //if its numeric and submitted rating is above maximum
1487         throw new rating_exception('invalidnum');
1488     }
1490     if ($info->approval && !$info->approved) {
1491         //database requires approval but this item isnt approved
1492         throw new rating_exception('nopermissiontorate');
1493     }
1495     // check the item we're rating was created in the assessable time window
1496     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1497         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1498             throw new rating_exception('notavailable');
1499         }
1500     }
1502     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1503     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1504     $context = context_module::instance($cm->id);
1506     // if the supplied context doesnt match the item's context
1507     if ($context->id != $params['context']->id) {
1508         throw new rating_exception('invalidcontext');
1509     }
1511     // Make sure groups allow this user to see the item they're rating
1512     $groupid = $info->groupid;
1513     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1514         if (!groups_group_exists($groupid)) { // Can't find group
1515             throw new rating_exception('cannotfindgroup');//something is wrong
1516         }
1518         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1519             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1520             throw new rating_exception('notmemberofgroup');
1521         }
1522     }
1524     return true;
1528 /**
1529  * function that takes in the current data, number of items per page,
1530  * a search string and prints a preference box in view.php
1531  *
1532  * This preference box prints a searchable advanced search template if
1533  *     a) A template is defined
1534  *  b) The advanced search checkbox is checked.
1535  *
1536  * @global object
1537  * @global object
1538  * @param object $data
1539  * @param int $perpage
1540  * @param string $search
1541  * @param string $sort
1542  * @param string $order
1543  * @param array $search_array
1544  * @param int $advanced
1545  * @param string $mode
1546  * @return void
1547  */
1548 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1549     global $CFG, $DB, $PAGE, $OUTPUT;
1551     $cm = get_coursemodule_from_instance('data', $data->id);
1552     $context = context_module::instance($cm->id);
1553     echo '<br /><div class="datapreferences">';
1554     echo '<form id="options" action="view.php" method="get">';
1555     echo '<div>';
1556     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1557     if ($mode =='asearch') {
1558         $advanced = 1;
1559         echo '<input type="hidden" name="mode" value="list" />';
1560     }
1561     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1562     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1563                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1564     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id'=>'pref_perpage'));
1566     if ($advanced) {
1567         $regsearchclass = 'search_none';
1568         $advancedsearchclass = 'search_inline';
1569     } else {
1570         $regsearchclass = 'search_inline';
1571         $advancedsearchclass = 'search_none';
1572     }
1573     echo '<div id="reg_search" class="' . $regsearchclass . '" >&nbsp;&nbsp;&nbsp;';
1574     echo '<label for="pref_search">'.get_string('search').'</label> <input type="text" size="16" name="search" id= "pref_search" value="'.s($search).'" /></div>';
1575     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1576     // foreach field, print the option
1577     echo '<select name="sort" id="pref_sortby">';
1578     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1579         echo '<optgroup label="'.get_string('fields', 'data').'">';
1580         foreach ($fields as $field) {
1581             if ($field->id == $sort) {
1582                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1583             } else {
1584                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1585             }
1586         }
1587         echo '</optgroup>';
1588     }
1589     $options = array();
1590     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1591     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1592     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1593     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1594     if ($data->approval and has_capability('mod/data:approve', $context)) {
1595         $options[DATA_APPROVED] = get_string('approved', 'data');
1596     }
1597     echo '<optgroup label="'.get_string('other', 'data').'">';
1598     foreach ($options as $key => $name) {
1599         if ($key == $sort) {
1600             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1601         } else {
1602             echo '<option value="'.$key.'">'.$name.'</option>';
1603         }
1604     }
1605     echo '</optgroup>';
1606     echo '</select>';
1607     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1608     echo '<select id="pref_order" name="order">';
1609     if ($order == 'ASC') {
1610         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1611     } else {
1612         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1613     }
1614     if ($order == 'DESC') {
1615         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1616     } else {
1617         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1618     }
1619     echo '</select>';
1621     if ($advanced) {
1622         $checked = ' checked="checked" ';
1623     }
1624     else {
1625         $checked = '';
1626     }
1627     $PAGE->requires->js('/mod/data/data.js');
1628     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1629     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1630     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1631     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1633     echo '<br />';
1634     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1635     echo '<table class="boxaligncenter">';
1637     // print ASC or DESC
1638     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1639     $i = 0;
1641     // Determine if we are printing all fields for advanced search, or the template for advanced search
1642     // If a template is not defined, use the deafault template and display all fields.
1643     if(empty($data->asearchtemplate)) {
1644         data_generate_default_template($data, 'asearchtemplate');
1645     }
1647     static $fields = NULL;
1648     static $isteacher;
1649     static $dataid = NULL;
1651     if (empty($dataid)) {
1652         $dataid = $data->id;
1653     } else if ($dataid != $data->id) {
1654         $fields = NULL;
1655     }
1657     if (empty($fields)) {
1658         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1659         foreach ($fieldrecords as $fieldrecord) {
1660             $fields[]= data_get_field($fieldrecord, $data);
1661         }
1663         $isteacher = has_capability('mod/data:managetemplates', $context);
1664     }
1666     // Replacing tags
1667     $patterns = array();
1668     $replacement = array();
1670     // Then we generate strings to replace for normal tags
1671     foreach ($fields as $field) {
1672         $fieldname = $field->field->name;
1673         $fieldname = preg_quote($fieldname, '/');
1674         $patterns[] = "/\[\[$fieldname\]\]/i";
1675         $searchfield = data_get_field_from_id($field->field->id, $data);
1676         if (!empty($search_array[$field->field->id]->data)) {
1677             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1678         } else {
1679             $replacement[] = $searchfield->display_search_field();
1680         }
1681     }
1682     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1683     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1684     $patterns[]    = '/##firstname##/';
1685     $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.'" />';
1686     $patterns[]    = '/##lastname##/';
1687     $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.'" />';
1689     // actual replacement of the tags
1690     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1692     $options = new stdClass();
1693     $options->para=false;
1694     $options->noclean=true;
1695     echo '<tr><td>';
1696     echo format_text($newtext, FORMAT_HTML, $options);
1697     echo '</td></tr>';
1699     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>';
1700     echo '</table>';
1701     echo '</div>';
1702     echo '</div>';
1703     echo '</form>';
1704     echo '</div>';
1707 /**
1708  * @global object
1709  * @global object
1710  * @param object $data
1711  * @param object $record
1712  * @return void Output echo'd
1713  */
1714 function data_print_ratings($data, $record) {
1715     global $OUTPUT;
1716     if (!empty($record->rating)){
1717         echo $OUTPUT->render($record->rating);
1718     }
1721 /**
1722  * List the actions that correspond to a view of this module.
1723  * This is used by the participation report.
1724  *
1725  * Note: This is not used by new logging system. Event with
1726  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1727  *       be considered as view action.
1728  *
1729  * @return array
1730  */
1731 function data_get_view_actions() {
1732     return array('view');
1735 /**
1736  * List the actions that correspond to a post of this module.
1737  * This is used by the participation report.
1738  *
1739  * Note: This is not used by new logging system. Event with
1740  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1741  *       will be considered as post action.
1742  *
1743  * @return array
1744  */
1745 function data_get_post_actions() {
1746     return array('add','update','record delete');
1749 /**
1750  * @param string $name
1751  * @param int $dataid
1752  * @param int $fieldid
1753  * @return bool
1754  */
1755 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
1756     global $DB;
1758     if (!is_numeric($name)) {
1759         $like = $DB->sql_like('df.name', ':name', false);
1760     } else {
1761         $like = "df.name = :name";
1762     }
1763     $params = array('name'=>$name);
1764     if ($fieldid) {
1765         $params['dataid']   = $dataid;
1766         $params['fieldid1'] = $fieldid;
1767         $params['fieldid2'] = $fieldid;
1768         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1769                                         WHERE $like AND df.dataid = :dataid
1770                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
1771     } else {
1772         $params['dataid']   = $dataid;
1773         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1774                                         WHERE $like AND df.dataid = :dataid", $params);
1775     }
1778 /**
1779  * @param array $fieldinput
1780  */
1781 function data_convert_arrays_to_strings(&$fieldinput) {
1782     foreach ($fieldinput as $key => $val) {
1783         if (is_array($val)) {
1784             $str = '';
1785             foreach ($val as $inner) {
1786                 $str .= $inner . ',';
1787             }
1788             $str = substr($str, 0, -1);
1790             $fieldinput->$key = $str;
1791         }
1792     }
1796 /**
1797  * Converts a database (module instance) to use the Roles System
1798  *
1799  * @global object
1800  * @global object
1801  * @uses CONTEXT_MODULE
1802  * @uses CAP_PREVENT
1803  * @uses CAP_ALLOW
1804  * @param object $data a data object with the same attributes as a record
1805  *                     from the data database table
1806  * @param int $datamodid the id of the data module, from the modules table
1807  * @param array $teacherroles array of roles that have archetype teacher
1808  * @param array $studentroles array of roles that have archetype student
1809  * @param array $guestroles array of roles that have archetype guest
1810  * @param int $cmid the course_module id for this data instance
1811  * @return boolean data module was converted or not
1812  */
1813 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1814     global $CFG, $DB, $OUTPUT;
1816     if (!isset($data->participants) && !isset($data->assesspublic)
1817             && !isset($data->groupmode)) {
1818         // We assume that this database has already been converted to use the
1819         // Roles System. above fields get dropped the data module has been
1820         // upgraded to use Roles.
1821         return false;
1822     }
1824     if (empty($cmid)) {
1825         // We were not given the course_module id. Try to find it.
1826         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1827             echo $OUTPUT->notification('Could not get the course module for the data');
1828             return false;
1829         } else {
1830             $cmid = $cm->id;
1831         }
1832     }
1833     $context = context_module::instance($cmid);
1836     // $data->participants:
1837     // 1 - Only teachers can add entries
1838     // 3 - Teachers and students can add entries
1839     switch ($data->participants) {
1840         case 1:
1841             foreach ($studentroles as $studentrole) {
1842                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1843             }
1844             foreach ($teacherroles as $teacherrole) {
1845                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1846             }
1847             break;
1848         case 3:
1849             foreach ($studentroles as $studentrole) {
1850                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1851             }
1852             foreach ($teacherroles as $teacherrole) {
1853                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1854             }
1855             break;
1856     }
1858     // $data->assessed:
1859     // 2 - Only teachers can rate posts
1860     // 1 - Everyone can rate posts
1861     // 0 - No one can rate posts
1862     switch ($data->assessed) {
1863         case 0:
1864             foreach ($studentroles as $studentrole) {
1865                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1866             }
1867             foreach ($teacherroles as $teacherrole) {
1868                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1869             }
1870             break;
1871         case 1:
1872             foreach ($studentroles as $studentrole) {
1873                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1874             }
1875             foreach ($teacherroles as $teacherrole) {
1876                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1877             }
1878             break;
1879         case 2:
1880             foreach ($studentroles as $studentrole) {
1881                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1882             }
1883             foreach ($teacherroles as $teacherrole) {
1884                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1885             }
1886             break;
1887     }
1889     // $data->assesspublic:
1890     // 0 - Students can only see their own ratings
1891     // 1 - Students can see everyone's ratings
1892     switch ($data->assesspublic) {
1893         case 0:
1894             foreach ($studentroles as $studentrole) {
1895                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1896             }
1897             foreach ($teacherroles as $teacherrole) {
1898                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1899             }
1900             break;
1901         case 1:
1902             foreach ($studentroles as $studentrole) {
1903                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1904             }
1905             foreach ($teacherroles as $teacherrole) {
1906                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1907             }
1908             break;
1909     }
1911     if (empty($cm)) {
1912         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1913     }
1915     switch ($cm->groupmode) {
1916         case NOGROUPS:
1917             break;
1918         case SEPARATEGROUPS:
1919             foreach ($studentroles as $studentrole) {
1920                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1921             }
1922             foreach ($teacherroles as $teacherrole) {
1923                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1924             }
1925             break;
1926         case VISIBLEGROUPS:
1927             foreach ($studentroles as $studentrole) {
1928                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1929             }
1930             foreach ($teacherroles as $teacherrole) {
1931                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1932             }
1933             break;
1934     }
1935     return true;
1938 /**
1939  * Returns the best name to show for a preset
1940  *
1941  * @param string $shortname
1942  * @param  string $path
1943  * @return string
1944  */
1945 function data_preset_name($shortname, $path) {
1947     // We are looking inside the preset itself as a first choice, but also in normal data directory
1948     $string = get_string('modulename', 'datapreset_'.$shortname);
1950     if (substr($string, 0, 1) == '[') {
1951         return $shortname;
1952     } else {
1953         return $string;
1954     }
1957 /**
1958  * Returns an array of all the available presets.
1959  *
1960  * @return array
1961  */
1962 function data_get_available_presets($context) {
1963     global $CFG, $USER;
1965     $presets = array();
1967     // First load the ratings sub plugins that exist within the modules preset dir
1968     if ($dirs = core_component::get_plugin_list('datapreset')) {
1969         foreach ($dirs as $dir=>$fulldir) {
1970             if (is_directory_a_preset($fulldir)) {
1971                 $preset = new stdClass();
1972                 $preset->path = $fulldir;
1973                 $preset->userid = 0;
1974                 $preset->shortname = $dir;
1975                 $preset->name = data_preset_name($dir, $fulldir);
1976                 if (file_exists($fulldir.'/screenshot.jpg')) {
1977                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1978                 } else if (file_exists($fulldir.'/screenshot.png')) {
1979                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1980                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1981                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1982                 }
1983                 $presets[] = $preset;
1984             }
1985         }
1986     }
1987     // Now add to that the site presets that people have saved
1988     $presets = data_get_available_site_presets($context, $presets);
1989     return $presets;
1992 /**
1993  * Gets an array of all of the presets that users have saved to the site.
1994  *
1995  * @param stdClass $context The context that we are looking from.
1996  * @param array $presets
1997  * @return array An array of presets
1998  */
1999 function data_get_available_site_presets($context, array $presets=array()) {
2000     global $USER;
2002     $fs = get_file_storage();
2003     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2004     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
2005     if (empty($files)) {
2006         return $presets;
2007     }
2008     foreach ($files as $file) {
2009         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
2010             continue;
2011         }
2012         $preset = new stdClass;
2013         $preset->path = $file->get_filepath();
2014         $preset->name = trim($preset->path, '/');
2015         $preset->shortname = $preset->name;
2016         $preset->userid = $file->get_userid();
2017         $preset->id = $file->get_id();
2018         $preset->storedfile = $file;
2019         $presets[] = $preset;
2020     }
2021     return $presets;
2024 /**
2025  * Deletes a saved preset.
2026  *
2027  * @param string $name
2028  * @return bool
2029  */
2030 function data_delete_site_preset($name) {
2031     $fs = get_file_storage();
2033     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
2034     if (!empty($files)) {
2035         foreach ($files as $file) {
2036             $file->delete();
2037         }
2038     }
2040     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
2041     if (!empty($dir)) {
2042         $dir->delete();
2043     }
2044     return true;
2047 /**
2048  * Prints the heads for a page
2049  *
2050  * @param stdClass $course
2051  * @param stdClass $cm
2052  * @param stdClass $data
2053  * @param string $currenttab
2054  */
2055 function data_print_header($course, $cm, $data, $currenttab='') {
2057     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
2059     $PAGE->set_title($data->name);
2060     echo $OUTPUT->header();
2061     echo $OUTPUT->heading(format_string($data->name), 2);
2062     echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro');
2064     // Groups needed for Add entry tab
2065     $currentgroup = groups_get_activity_group($cm);
2066     $groupmode = groups_get_activity_groupmode($cm);
2068     // Print the tabs
2070     if ($currenttab) {
2071         include('tabs.php');
2072     }
2074     // Print any notices
2076     if (!empty($displaynoticegood)) {
2077         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
2078     } else if (!empty($displaynoticebad)) {
2079         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
2080     }
2083 /**
2084  * Can user add more entries?
2085  *
2086  * @param object $data
2087  * @param mixed $currentgroup
2088  * @param int $groupmode
2089  * @param stdClass $context
2090  * @return bool
2091  */
2092 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2093     global $USER;
2095     if (empty($context)) {
2096         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2097         $context = context_module::instance($cm->id);
2098     }
2100     if (has_capability('mod/data:manageentries', $context)) {
2101         // no entry limits apply if user can manage
2103     } else if (!has_capability('mod/data:writeentry', $context)) {
2104         return false;
2106     } else if (data_atmaxentries($data)) {
2107         return false;
2108     } else if (data_in_readonly_period($data)) {
2109         // Check whether we're in a read-only period
2110         return false;
2111     }
2113     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2114         return true;
2115     }
2117     if ($currentgroup) {
2118         return groups_is_member($currentgroup);
2119     } else {
2120         //else it might be group 0 in visible mode
2121         if ($groupmode == VISIBLEGROUPS){
2122             return true;
2123         } else {
2124             return false;
2125         }
2126     }
2129 /**
2130  * Check whether the specified database activity is currently in a read-only period
2131  *
2132  * @param object $data
2133  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2134  */
2135 function data_in_readonly_period($data) {
2136     $now = time();
2137     if (!$data->timeviewfrom && !$data->timeviewto) {
2138         return false;
2139     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2140         return false;
2141     }
2142     return true;
2145 /**
2146  * @return bool
2147  */
2148 function is_directory_a_preset($directory) {
2149     $directory = rtrim($directory, '/\\') . '/';
2150     $status = file_exists($directory.'singletemplate.html') &&
2151               file_exists($directory.'listtemplate.html') &&
2152               file_exists($directory.'listtemplateheader.html') &&
2153               file_exists($directory.'listtemplatefooter.html') &&
2154               file_exists($directory.'addtemplate.html') &&
2155               file_exists($directory.'rsstemplate.html') &&
2156               file_exists($directory.'rsstitletemplate.html') &&
2157               file_exists($directory.'csstemplate.css') &&
2158               file_exists($directory.'jstemplate.js') &&
2159               file_exists($directory.'preset.xml');
2161     return $status;
2164 /**
2165  * Abstract class used for data preset importers
2166  */
2167 abstract class data_preset_importer {
2169     protected $course;
2170     protected $cm;
2171     protected $module;
2172     protected $directory;
2174     /**
2175      * Constructor
2176      *
2177      * @param stdClass $course
2178      * @param stdClass $cm
2179      * @param stdClass $module
2180      * @param string $directory
2181      */
2182     public function __construct($course, $cm, $module, $directory) {
2183         $this->course = $course;
2184         $this->cm = $cm;
2185         $this->module = $module;
2186         $this->directory = $directory;
2187     }
2189     /**
2190      * Returns the name of the directory the preset is located in
2191      * @return string
2192      */
2193     public function get_directory() {
2194         return basename($this->directory);
2195     }
2197     /**
2198      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2199      * @param file_storage $filestorage. should be null if using a conventional directory
2200      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2201      * @param string $dir the directory to look in. null if using the Moodle file storage
2202      * @param string $filename the name of the file we want
2203      * @return string the contents of the file or null if the file doesn't exist.
2204      */
2205     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2206         if(empty($filestorage) || empty($fileobj)) {
2207             if (substr($dir, -1)!='/') {
2208                 $dir .= '/';
2209             }
2210             if (file_exists($dir.$filename)) {
2211                 return file_get_contents($dir.$filename);
2212             } else {
2213                 return null;
2214             }
2215         } else {
2216             if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
2217                 $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2218                 return $file->get_content();
2219             } else {
2220                 return null;
2221             }
2222         }
2224     }
2225     /**
2226      * Gets the preset settings
2227      * @global moodle_database $DB
2228      * @return stdClass
2229      */
2230     public function get_preset_settings() {
2231         global $DB;
2233         $fs = $fileobj = null;
2234         if (!is_directory_a_preset($this->directory)) {
2235             //maybe the user requested a preset stored in the Moodle file storage
2237             $fs = get_file_storage();
2238             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2240             //preset name to find will be the final element of the directory
2241             $explodeddirectory = explode('/', $this->directory);
2242             $presettofind = end($explodeddirectory);
2244             //now go through the available files available and see if we can find it
2245             foreach ($files as $file) {
2246                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2247                     continue;
2248                 }
2249                 $presetname = trim($file->get_filepath(), '/');
2250                 if ($presetname==$presettofind) {
2251                     $this->directory = $presetname;
2252                     $fileobj = $file;
2253                 }
2254             }
2256             if (empty($fileobj)) {
2257                 print_error('invalidpreset', 'data', '', $this->directory);
2258             }
2259         }
2261         $allowed_settings = array(
2262             'intro',
2263             'comments',
2264             'requiredentries',
2265             'requiredentriestoview',
2266             'maxentries',
2267             'rssarticles',
2268             'approval',
2269             'defaultsortdir',
2270             'defaultsort');
2272         $result = new stdClass;
2273         $result->settings = new stdClass;
2274         $result->importfields = array();
2275         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2276         if (!$result->currentfields) {
2277             $result->currentfields = array();
2278         }
2281         /* Grab XML */
2282         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2283         $parsedxml = xmlize($presetxml, 0);
2285         /* First, do settings. Put in user friendly array. */
2286         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2287         $result->settings = new StdClass();
2288         foreach ($settingsarray as $setting => $value) {
2289             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2290                 // unsupported setting
2291                 continue;
2292             }
2293             $result->settings->$setting = $value[0]['#'];
2294         }
2296         /* Now work out fields to user friendly array */
2297         $fieldsarray = $parsedxml['preset']['#']['field'];
2298         foreach ($fieldsarray as $field) {
2299             if (!is_array($field)) {
2300                 continue;
2301             }
2302             $f = new StdClass();
2303             foreach ($field['#'] as $param => $value) {
2304                 if (!is_array($value)) {
2305                     continue;
2306                 }
2307                 $f->$param = $value[0]['#'];
2308             }
2309             $f->dataid = $this->module->id;
2310             $f->type = clean_param($f->type, PARAM_ALPHA);
2311             $result->importfields[] = $f;
2312         }
2313         /* Now add the HTML templates to the settings array so we can update d */
2314         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2315         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2316         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2317         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2318         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2319         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2320         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2321         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2322         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2323         $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2325         $result->settings->instance = $this->module->id;
2326         return $result;
2327     }
2329     /**
2330      * Import the preset into the given database module
2331      * @return bool
2332      */
2333     function import($overwritesettings) {
2334         global $DB, $CFG;
2336         $params = $this->get_preset_settings();
2337         $settings = $params->settings;
2338         $newfields = $params->importfields;
2339         $currentfields = $params->currentfields;
2340         $preservedfields = array();
2342         /* Maps fields and makes new ones */
2343         if (!empty($newfields)) {
2344             /* We require an injective mapping, and need to know what to protect */
2345             foreach ($newfields as $nid => $newfield) {
2346                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2347                 if ($cid == -1) {
2348                     continue;
2349                 }
2350                 if (array_key_exists($cid, $preservedfields)){
2351                     print_error('notinjectivemap', 'data');
2352                 }
2353                 else $preservedfields[$cid] = true;
2354             }
2356             foreach ($newfields as $nid => $newfield) {
2357                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2359                 /* A mapping. Just need to change field params. Data kept. */
2360                 if ($cid != -1 and isset($currentfields[$cid])) {
2361                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2362                     foreach ($newfield as $param => $value) {
2363                         if ($param != "id") {
2364                             $fieldobject->field->$param = $value;
2365                         }
2366                     }
2367                     unset($fieldobject->field->similarfield);
2368                     $fieldobject->update_field();
2369                     unset($fieldobject);
2370                 } else {
2371                     /* Make a new field */
2372                     include_once("field/$newfield->type/field.class.php");
2374                     if (!isset($newfield->description)) {
2375                         $newfield->description = '';
2376                     }
2377                     $classname = 'data_field_'.$newfield->type;
2378                     $fieldclass = new $classname($newfield, $this->module);
2379                     $fieldclass->insert_field();
2380                     unset($fieldclass);
2381                 }
2382             }
2383         }
2385         /* Get rid of all old unused data */
2386         if (!empty($preservedfields)) {
2387             foreach ($currentfields as $cid => $currentfield) {
2388                 if (!array_key_exists($cid, $preservedfields)) {
2389                     /* Data not used anymore so wipe! */
2390                     print "Deleting field $currentfield->name<br />";
2392                     $id = $currentfield->id;
2393                     //Why delete existing data records and related comments/ratings??
2394                     $DB->delete_records('data_content', array('fieldid'=>$id));
2395                     $DB->delete_records('data_fields', array('id'=>$id));
2396                 }
2397             }
2398         }
2400         // handle special settings here
2401         if (!empty($settings->defaultsort)) {
2402             if (is_numeric($settings->defaultsort)) {
2403                 // old broken value
2404                 $settings->defaultsort = 0;
2405             } else {
2406                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2407             }
2408         } else {
2409             $settings->defaultsort = 0;
2410         }
2412         // do we want to overwrite all current database settings?
2413         if ($overwritesettings) {
2414             // all supported settings
2415             $overwrite = array_keys((array)$settings);
2416         } else {
2417             // only templates and sorting
2418             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2419                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2420                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2421         }
2423         // now overwrite current data settings
2424         foreach ($this->module as $prop=>$unused) {
2425             if (in_array($prop, $overwrite)) {
2426                 $this->module->$prop = $settings->$prop;
2427             }
2428         }
2430         data_update_instance($this->module);
2432         return $this->cleanup();
2433     }
2435     /**
2436      * Any clean up routines should go here
2437      * @return bool
2438      */
2439     public function cleanup() {
2440         return true;
2441     }
2444 /**
2445  * Data preset importer for uploaded presets
2446  */
2447 class data_preset_upload_importer extends data_preset_importer {
2448     public function __construct($course, $cm, $module, $filepath) {
2449         global $USER;
2450         if (is_file($filepath)) {
2451             $fp = get_file_packer();
2452             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2453                 fulldelete($filepath);
2454             }
2455             $filepath .= '_extracted';
2456         }
2457         parent::__construct($course, $cm, $module, $filepath);
2458     }
2459     public function cleanup() {
2460         return fulldelete($this->directory);
2461     }
2464 /**
2465  * Data preset importer for existing presets
2466  */
2467 class data_preset_existing_importer extends data_preset_importer {
2468     protected $userid;
2469     public function __construct($course, $cm, $module, $fullname) {
2470         global $USER;
2471         list($userid, $shortname) = explode('/', $fullname, 2);
2472         $context = context_module::instance($cm->id);
2473         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2474            throw new coding_exception('Invalid preset provided');
2475         }
2477         $this->userid = $userid;
2478         $filepath = data_preset_path($course, $userid, $shortname);
2479         parent::__construct($course, $cm, $module, $filepath);
2480     }
2481     public function get_userid() {
2482         return $this->userid;
2483     }
2486 /**
2487  * @global object
2488  * @global object
2489  * @param object $course
2490  * @param int $userid
2491  * @param string $shortname
2492  * @return string
2493  */
2494 function data_preset_path($course, $userid, $shortname) {
2495     global $USER, $CFG;
2497     $context = context_course::instance($course->id);
2499     $userid = (int)$userid;
2501     $path = null;
2502     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2503         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2504     } else if ($userid == 0) {
2505         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2506     } else if ($userid < 0) {
2507         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2508     }
2510     return $path;
2513 /**
2514  * Implementation of the function for printing the form elements that control
2515  * whether the course reset functionality affects the data.
2516  *
2517  * @param $mform form passed by reference
2518  */
2519 function data_reset_course_form_definition(&$mform) {
2520     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2521     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2523     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2524     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2526     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2527     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2529     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2530     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2533 /**
2534  * Course reset form defaults.
2535  * @return array
2536  */
2537 function data_reset_course_form_defaults($course) {
2538     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2541 /**
2542  * Removes all grades from gradebook
2543  *
2544  * @global object
2545  * @global object
2546  * @param int $courseid
2547  * @param string $type optional type
2548  */
2549 function data_reset_gradebook($courseid, $type='') {
2550     global $CFG, $DB;
2552     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2553               FROM {data} d, {course_modules} cm, {modules} m
2554              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2556     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2557         foreach ($datas as $data) {
2558             data_grade_item_update($data, 'reset');
2559         }
2560     }
2563 /**
2564  * Actual implementation of the reset course functionality, delete all the
2565  * data responses for course $data->courseid.
2566  *
2567  * @global object
2568  * @global object
2569  * @param object $data the data submitted from the reset course.
2570  * @return array status array
2571  */
2572 function data_reset_userdata($data) {
2573     global $CFG, $DB;
2574     require_once($CFG->libdir.'/filelib.php');
2575     require_once($CFG->dirroot.'/rating/lib.php');
2577     $componentstr = get_string('modulenameplural', 'data');
2578     $status = array();
2580     $allrecordssql = "SELECT r.id
2581                         FROM {data_records} r
2582                              INNER JOIN {data} d ON r.dataid = d.id
2583                        WHERE d.course = ?";
2585     $alldatassql = "SELECT d.id
2586                       FROM {data} d
2587                      WHERE d.course=?";
2589     $rm = new rating_manager();
2590     $ratingdeloptions = new stdClass;
2591     $ratingdeloptions->component = 'mod_data';
2592     $ratingdeloptions->ratingarea = 'entry';
2594     // Set the file storage - may need it to remove files later.
2595     $fs = get_file_storage();
2597     // delete entries if requested
2598     if (!empty($data->reset_data)) {
2599         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2600         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2601         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2603         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2604             foreach ($datas as $dataid=>$unused) {
2605                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2606                     continue;
2607                 }
2608                 $datacontext = context_module::instance($cm->id);
2610                 // Delete any files that may exist.
2611                 $fs->delete_area_files($datacontext->id, 'mod_data', 'content');
2613                 $ratingdeloptions->contextid = $datacontext->id;
2614                 $rm->delete_ratings($ratingdeloptions);
2615             }
2616         }
2618         if (empty($data->reset_gradebook_grades)) {
2619             // remove all grades from gradebook
2620             data_reset_gradebook($data->courseid);
2621         }
2622         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2623     }
2625     // remove entries by users not enrolled into course
2626     if (!empty($data->reset_data_notenrolled)) {
2627         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2628                          FROM {data_records} r
2629                               JOIN {data} d ON r.dataid = d.id
2630                               LEFT JOIN {user} u ON r.userid = u.id
2631                         WHERE d.course = ? AND r.userid > 0";
2633         $course_context = context_course::instance($data->courseid);
2634         $notenrolled = array();
2635         $fields = array();
2636         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2637         foreach ($rs as $record) {
2638             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2639               or !is_enrolled($course_context, $record->userid)) {
2640                 //delete ratings
2641                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2642                     continue;
2643                 }
2644                 $datacontext = context_module::instance($cm->id);
2645                 $ratingdeloptions->contextid = $datacontext->id;
2646                 $ratingdeloptions->itemid = $record->id;
2647                 $rm->delete_ratings($ratingdeloptions);
2649                 // Delete any files that may exist.
2650                 if ($contents = $DB->get_records('data_content', array('recordid' => $record->id), '', 'id')) {
2651                     foreach ($contents as $content) {
2652                         $fs->delete_area_files($datacontext->id, 'mod_data', 'content', $content->id);
2653                     }
2654                 }
2655                 $notenrolled[$record->userid] = true;
2657                 $DB->delete_records('comments', array('itemid' => $record->id, 'commentarea' => 'database_entry'));
2658                 $DB->delete_records('data_content', array('recordid' => $record->id));
2659                 $DB->delete_records('data_records', array('id' => $record->id));
2660             }
2661         }
2662         $rs->close();
2663         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2664     }
2666     // remove all ratings
2667     if (!empty($data->reset_data_ratings)) {
2668         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2669             foreach ($datas as $dataid=>$unused) {
2670                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2671                     continue;
2672                 }
2673                 $datacontext = context_module::instance($cm->id);
2675                 $ratingdeloptions->contextid = $datacontext->id;
2676                 $rm->delete_ratings($ratingdeloptions);
2677             }
2678         }
2680         if (empty($data->reset_gradebook_grades)) {
2681             // remove all grades from gradebook
2682             data_reset_gradebook($data->courseid);
2683         }
2685         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2686     }
2688     // remove all comments
2689     if (!empty($data->reset_data_comments)) {
2690         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2691         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2692     }
2694     // updating dates - shift may be negative too
2695     if ($data->timeshift) {
2696         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2697         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2698     }
2700     return $status;
2703 /**
2704  * Returns all other caps used in module
2705  *
2706  * @return array
2707  */
2708 function data_get_extra_capabilities() {
2709     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');
2712 /**
2713  * @param string $feature FEATURE_xx constant for requested feature
2714  * @return mixed True if module supports feature, null if doesn't know
2715  */
2716 function data_supports($feature) {
2717     switch($feature) {
2718         case FEATURE_GROUPS:                  return true;
2719         case FEATURE_GROUPINGS:               return true;
2720         case FEATURE_MOD_INTRO:               return true;
2721         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2722         case FEATURE_GRADE_HAS_GRADE:         return true;
2723         case FEATURE_GRADE_OUTCOMES:          return true;
2724         case FEATURE_RATE:                    return true;
2725         case FEATURE_BACKUP_MOODLE2:          return true;
2726         case FEATURE_SHOW_DESCRIPTION:        return true;
2728         default: return null;
2729     }
2731 /**
2732  * @global object
2733  * @param array $export
2734  * @param string $delimiter_name
2735  * @param object $database
2736  * @param int $count
2737  * @param bool $return
2738  * @return string|void
2739  */
2740 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
2741     global $CFG;
2742     require_once($CFG->libdir . '/csvlib.class.php');
2744     $filename = $database . '-' . $count . '-record';
2745     if ($count > 1) {
2746         $filename .= 's';
2747     }
2748     if ($return) {
2749         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
2750     } else {
2751         csv_export_writer::download_array($filename, $export, $delimiter_name);
2752     }
2755 /**
2756  * @global object
2757  * @param array $export
2758  * @param string $dataname
2759  * @param int $count
2760  * @return string
2761  */
2762 function data_export_xls($export, $dataname, $count) {
2763     global $CFG;
2764     require_once("$CFG->libdir/excellib.class.php");
2765     $filename = clean_filename("{$dataname}-{$count}_record");
2766     if ($count > 1) {
2767         $filename .= 's';
2768     }
2769     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2770     $filename .= '.xls';
2772     $filearg = '-';
2773     $workbook = new MoodleExcelWorkbook($filearg);
2774     $workbook->send($filename);
2775     $worksheet = array();
2776     $worksheet[0] = $workbook->add_worksheet('');
2777     $rowno = 0;
2778     foreach ($export as $row) {
2779         $colno = 0;
2780         foreach($row as $col) {
2781             $worksheet[0]->write($rowno, $colno, $col);
2782             $colno++;
2783         }
2784         $rowno++;
2785     }
2786     $workbook->close();
2787     return $filename;
2790 /**
2791  * @global object
2792  * @param array $export
2793  * @param string $dataname
2794  * @param int $count
2795  * @param string
2796  */
2797 function data_export_ods($export, $dataname, $count) {
2798     global $CFG;
2799     require_once("$CFG->libdir/odslib.class.php");
2800     $filename = clean_filename("{$dataname}-{$count}_record");
2801     if ($count > 1) {
2802         $filename .= 's';
2803     }
2804     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2805     $filename .= '.ods';
2806     $filearg = '-';
2807     $workbook = new MoodleODSWorkbook($filearg);
2808     $workbook->send($filename);
2809     $worksheet = array();
2810     $worksheet[0] = $workbook->add_worksheet('');
2811     $rowno = 0;
2812     foreach ($export as $row) {
2813         $colno = 0;
2814         foreach($row as $col) {
2815             $worksheet[0]->write($rowno, $colno, $col);
2816             $colno++;
2817         }
2818         $rowno++;
2819     }
2820     $workbook->close();
2821     return $filename;
2824 /**
2825  * @global object
2826  * @param int $dataid
2827  * @param array $fields
2828  * @param array $selectedfields
2829  * @param int $currentgroup group ID of the current group. This is used for
2830  * exporting data while maintaining group divisions.
2831  * @param object $context the context in which the operation is performed (for capability checks)
2832  * @param bool $userdetails whether to include the details of the record author
2833  * @param bool $time whether to include time created/modified
2834  * @param bool $approval whether to include approval status
2835  * @return array
2836  */
2837 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
2838                              $userdetails=false, $time=false, $approval=false) {
2839     global $DB;
2841     if (is_null($context)) {
2842         $context = context_system::instance();
2843     }
2844     // exporting user data needs special permission
2845     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
2847     $exportdata = array();
2849     // populate the header in first row of export
2850     foreach($fields as $key => $field) {
2851         if (!in_array($field->field->id, $selectedfields)) {
2852             // ignore values we aren't exporting
2853             unset($fields[$key]);
2854         } else {
2855             $exportdata[0][] = $field->field->name;
2856         }
2857     }
2858     if ($userdetails) {
2859         $exportdata[0][] = get_string('user');
2860         $exportdata[0][] = get_string('username');
2861         $exportdata[0][] = get_string('email');
2862     }
2863     if ($time) {
2864         $exportdata[0][] = get_string('timeadded', 'data');
2865         $exportdata[0][] = get_string('timemodified', 'data');
2866     }
2867     if ($approval) {
2868         $exportdata[0][] = get_string('approved', 'data');
2869     }
2871     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2872     ksort($datarecords);
2873     $line = 1;
2874     foreach($datarecords as $record) {
2875         // get content indexed by fieldid
2876         if ($currentgroup) {
2877             $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 = ?';
2878             $where = array($record->id, $currentgroup);
2879         } else {
2880             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
2881             $where = array($record->id);
2882         }
2884         if( $content = $DB->get_records_sql($select, $where) ) {
2885             foreach($fields as $field) {
2886                 $contents = '';
2887                 if(isset($content[$field->field->id])) {
2888                     $contents = $field->export_text_value($content[$field->field->id]);
2889                 }
2890                 $exportdata[$line][] = $contents;
2891             }
2892             if ($userdetails) { // Add user details to the export data
2893                 $userdata = get_complete_user_data('id', $record->userid);
2894                 $exportdata[$line][] = fullname($userdata);
2895                 $exportdata[$line][] = $userdata->username;
2896                 $exportdata[$line][] = $userdata->email;
2897             }
2898             if ($time) { // Add time added / modified
2899                 $exportdata[$line][] = userdate($record->timecreated);
2900                 $exportdata[$line][] = userdate($record->timemodified);
2901             }
2902             if ($approval) { // Add approval status
2903                 $exportdata[$line][] = (int) $record->approved;
2904             }
2905         }
2906         $line++;
2907     }
2908     $line--;
2909     return $exportdata;
2912 ////////////////////////////////////////////////////////////////////////////////
2913 // File API                                                                   //
2914 ////////////////////////////////////////////////////////////////////////////////
2916 /**
2917  * Lists all browsable file areas
2918  *
2919  * @package  mod_data
2920  * @category files
2921  * @param stdClass $course course object
2922  * @param stdClass $cm course module object
2923  * @param stdClass $context context object
2924  * @return array
2925  */
2926 function data_get_file_areas($course, $cm, $context) {
2927     return array('content' => get_string('areacontent', 'mod_data'));
2930 /**
2931  * File browsing support for data module.
2932  *
2933  * @param file_browser $browser
2934  * @param array $areas
2935  * @param stdClass $course
2936  * @param cm_info $cm
2937  * @param context $context
2938  * @param string $filearea
2939  * @param int $itemid
2940  * @param string $filepath
2941  * @param string $filename
2942  * @return file_info_stored file_info_stored instance or null if not found
2943  */
2944 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
2945     global $CFG, $DB, $USER;
2947     if ($context->contextlevel != CONTEXT_MODULE) {
2948         return null;
2949     }
2951     if (!isset($areas[$filearea])) {
2952         return null;
2953     }
2955     if (is_null($itemid)) {
2956         require_once($CFG->dirroot.'/mod/data/locallib.php');
2957         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
2958     }
2960     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
2961         return null;
2962     }
2964     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2965         return null;
2966     }
2968     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2969         return null;
2970     }
2972     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2973         return null;
2974     }
2976     //check if approved
2977     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2978         return null;
2979     }
2981     // group access
2982     if ($record->groupid) {
2983         $groupmode = groups_get_activity_groupmode($cm, $course);
2984         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2985             if (!groups_is_member($record->groupid)) {
2986                 return null;
2987             }
2988         }
2989     }
2991     $fieldobj = data_get_field($field, $data, $cm);
2993     $filepath = is_null($filepath) ? '/' : $filepath;
2994     $filename = is_null($filename) ? '.' : $filename;
2995     if (!$fieldobj->file_ok($filepath.$filename)) {
2996         return null;
2997     }
2999     $fs = get_file_storage();
3000     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
3001         return null;
3002     }
3004     // Checks to see if the user can manage files or is the owner.
3005     // TODO MDL-33805 - Do not use userid here and move the capability check above.
3006     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
3007         return null;
3008     }
3010     $urlbase = $CFG->wwwroot.'/pluginfile.php';
3012     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
3015 /**
3016  * Serves the data attachments. Implements needed access control ;-)
3017  *
3018  * @package  mod_data
3019  * @category files
3020  * @param stdClass $course course object
3021  * @param stdClass $cm course module object
3022  * @param stdClass $context context object
3023  * @param string $filearea file area
3024  * @param array $args extra arguments
3025  * @param bool $forcedownload whether or not force download
3026  * @param array $options additional options affecting the file serving
3027  * @return bool false if file not found, does not return if found - justsend the file
3028  */
3029 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
3030     global $CFG, $DB;
3032     if ($context->contextlevel != CONTEXT_MODULE) {
3033         return false;
3034     }
3036     require_course_login($course, true, $cm);
3038     if ($filearea === 'content') {
3039         $contentid = (int)array_shift($args);
3041         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
3042             return false;
3043         }
3045         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3046             return false;
3047         }
3049         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3050             return false;
3051         }
3053         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3054             return false;
3055         }
3057         if ($data->id != $cm->instance) {
3058             // hacker attempt - context does not match the contentid
3059             return false;
3060         }
3062         //check if approved
3063         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3064             return false;
3065         }
3067         // group access
3068         if ($record->groupid) {
3069             $groupmode = groups_get_activity_groupmode($cm, $course);
3070             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3071                 if (!groups_is_member($record->groupid)) {
3072                     return false;
3073                 }
3074             }
3075         }
3077         $fieldobj = data_get_field($field, $data, $cm);
3079         $relativepath = implode('/', $args);
3080         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
3082         if (!$fieldobj->file_ok($relativepath)) {
3083             return false;
3084         }
3086         $fs = get_file_storage();
3087         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3088             return false;
3089         }
3091         // finally send the file
3092         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
3093     }
3095     return false;
3099 function data_extend_navigation($navigation, $course, $module, $cm) {
3100     global $CFG, $OUTPUT, $USER, $DB;
3102     $rid = optional_param('rid', 0, PARAM_INT);
3104     $data = $DB->get_record('data', array('id'=>$cm->instance));
3105     $currentgroup = groups_get_activity_group($cm);
3106     $groupmode = groups_get_activity_groupmode($cm);
3108      $numentries = data_numentries($data);
3109     /// Check the number of entries required against the number of entries already made (doesn't apply to teachers)
3110     if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !has_capability('mod/data:manageentries', context_module::instance($cm->id))) {
3111         $data->entriesleft = $data->requiredentries - $numentries;
3112         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3113         $entriesnode->add_class('note');
3114     }
3116     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3117     if (!empty($rid)) {
3118         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3119     } else {
3120         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3121     }
3122     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3125 /**
3126  * Adds module specific settings to the settings block
3127  *
3128  * @param settings_navigation $settings The settings navigation object
3129  * @param navigation_node $datanode The node to add module settings to
3130  */
3131 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3132     global $PAGE, $DB, $CFG, $USER;
3134     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3136     $currentgroup = groups_get_activity_group($PAGE->cm);
3137     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3139     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3140         if (empty($editentry)) { //TODO: undefined
3141             $addstring = get_string('add', 'data');
3142         } else {
3143             $addstring = get_string('editentry', 'data');
3144         }
3145         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3146     }
3148     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3149         // The capability required to Export database records is centrally defined in 'lib.php'
3150         // and should be weaker than those required to edit Templates, Fields and Presets.
3151         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3152     }
3153     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3154         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3155     }
3157     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3158         $currenttab = '';
3159         if ($currenttab == 'list') {
3160             $defaultemplate = 'listtemplate';
3161         } else if ($currenttab == 'add') {
3162             $defaultemplate = 'addtemplate';
3163         } else if ($currenttab == 'asearch') {
3164             $defaultemplate = 'asearchtemplate';
3165         } else {
3166             $defaultemplate = 'singletemplate';
3167         }
3169         $templates = $datanode->add(get_string('templates', 'data'));
3171         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3172         foreach ($templatelist as $template) {
3173             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3174         }
3176         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3177         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3178     }
3180     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3181         require_once("$CFG->libdir/rsslib.php");
3183         $string = get_string('rsstype','forum');
3185         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3186         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3187     }
3190 /**
3191  * Save the database configuration as a preset.
3192  *
3193  * @param stdClass $course The course the database module belongs to.
3194  * @param stdClass $cm The course module record
3195  * @param stdClass $data The database record
3196  * @param string $path
3197  * @return bool
3198  */
3199 function data_presets_save($course, $cm, $data, $path) {
3200     global $USER;
3201     $fs = get_file_storage();
3202     $filerecord = new stdClass;
3203     $filerecord->contextid = DATA_PRESET_CONTEXT;
3204     $filerecord->component = DATA_PRESET_COMPONENT;
3205     $filerecord->filearea = DATA_PRESET_FILEAREA;
3206     $filerecord->itemid = 0;
3207     $filerecord->filepath = '/'.$path.'/';
3208     $filerecord->userid = $USER->id;
3210     $filerecord->filename = 'preset.xml';
3211     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3213     $filerecord->filename = 'singletemplate.html';
3214     $fs->create_file_from_string($filerecord, $data->singletemplate);
3216     $filerecord->filename = 'listtemplateheader.html';
3217     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3219     $filerecord->filename = 'listtemplate.html';
3220     $fs->create_file_from_string($filerecord, $data->listtemplate);
3222     $filerecord->filename = 'listtemplatefooter.html';
3223     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3225     $filerecord->filename = 'addtemplate.html';
3226     $fs->create_file_from_string($filerecord, $data->addtemplate);
3228     $filerecord->filename = 'rsstemplate.html';
3229     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3231     $filerecord->filename = 'rsstitletemplate.html';
3232     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3234     $filerecord->filename = 'csstemplate.css';
3235     $fs->create_file_from_string($filerecord, $data->csstemplate);
3237     $filerecord->filename = 'jstemplate.js';
3238     $fs->create_file_from_string($filerecord, $data->jstemplate);
3240     $filerecord->filename = 'asearchtemplate.html';
3241     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3243     return true;
3246 /**
3247  * Generates the XML for the database module provided
3248  *
3249  * @global moodle_database $DB
3250  * @param stdClass $course The course the database module belongs to.
3251  * @param stdClass $cm The course module record
3252  * @param stdClass $data The database record
3253  * @return string The XML for the preset
3254  */
3255 function data_presets_generate_xml($course, $cm, $data) {
3256     global $DB;
3258     // Assemble "preset.xml":
3259     $presetxmldata = "<preset>\n\n";
3261     // Raw settings are not preprocessed during saving of presets
3262     $raw_settings = array(
3263         'intro',
3264         'comments',
3265         'requiredentries',
3266         'requiredentriestoview',
3267         'maxentries',
3268         'rssarticles',
3269         'approval',
3270         'defaultsortdir'
3271     );
3273     $presetxmldata .= "<settings>\n";
3274     // First, settings that do not require any conversion
3275     foreach ($raw_settings as $setting) {
3276         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3277     }
3279     // Now specific settings
3280     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3281         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3282     } else {
3283         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3284     }
3285     $presetxmldata .= "</settings>\n\n";
3286     // Now for the fields. Grab all that are non-empty
3287     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3288     ksort($fields);
3289     if (!empty($fields)) {
3290         foreach ($fields as $field) {
3291             $presetxmldata .= "<field>\n";
3292             foreach ($field as $key => $value) {
3293                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3294                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3295                 }
3296             }
3297             $presetxmldata .= "</field>\n\n";
3298         }
3299     }
3300     $presetxmldata .= '</preset>';
3301     return $presetxmldata;
3304 function data_presets_export($course, $cm, $data, $tostorage=false) {
3305     global $CFG, $DB;
3307     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3308     $exportsubdir = "mod_data/presetexport/$presetname";
3309     make_temp_directory($exportsubdir);
3310     $exportdir = "$CFG->tempdir/$exportsubdir";
3312     // Assemble "preset.xml":
3313     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3315     // After opening a file in write mode, close it asap
3316     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3317     fwrite($presetxmlfile, $presetxmldata);
3318     fclose($presetxmlfile);
3320     // Now write the template files
3321     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3322     fwrite($singletemplate, $data->singletemplate);
3323     fclose($singletemplate);
3325     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3326     fwrite($listtemplateheader, $data->listtemplateheader);
3327     fclose($listtemplateheader);
3329     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3330     fwrite($listtemplate, $data->listtemplate);
3331     fclose($listtemplate);
3333     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3334     fwrite($listtemplatefooter, $data->listtemplatefooter);
3335     fclose($listtemplatefooter);
3337     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3338     fwrite($addtemplate, $data->addtemplate);
3339     fclose($addtemplate);
3341     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3342     fwrite($rsstemplate, $data->rsstemplate);
3343     fclose($rsstemplate);
3345     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3346     fwrite($rsstitletemplate, $data->rsstitletemplate);
3347     fclose($rsstitletemplate);
3349     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3350     fwrite($csstemplate, $data->csstemplate);
3351     fclose($csstemplate);
3353     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3354     fwrite($jstemplate, $data->jstemplate);
3355     fclose($jstemplate);
3357     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3358     fwrite($asearchtemplate, $data->asearchtemplate);
3359     fclose($asearchtemplate);
3361     // Check if all files have been generated
3362     if (! is_directory_a_preset($exportdir)) {
3363         print_error('generateerror', 'data');
3364     }
3366     $filenames = array(
3367         'preset.xml',
3368         'singletemplate.html',
3369         'listtemplateheader.html',
3370         'listtemplate.html',
3371         'listtemplatefooter.html',
3372         'addtemplate.html',
3373         'rsstemplate.html',
3374         'rsstitletemplate.html',
3375         'csstemplate.css',
3376         'jstemplate.js',
3377         'asearchtemplate.html'
3378     );
3380     $filelist = array();
3381     foreach ($filenames as $filename) {
3382         $filelist[$filename] = $exportdir . '/' . $filename;
3383     }
3385     $exportfile = $exportdir.'.zip';
3386     file_exists($exportfile) && unlink($exportfile);
3388     $fp = get_file_packer('application/zip');
3389     $fp->archive_to_pathname($filelist, $exportfile);
3391     foreach ($filelist as $file) {
3392         unlink($file);
3393     }
3394     rmdir($exportdir);
3396     // Return the full path to the exported preset file:
3397     return $exportfile;
3400 /**
3401  * Running addtional permission check on plugin, for example, plugins
3402  * may have switch to turn on/off comments option, this callback will
3403  * affect UI display, not like pluginname_comment_validate only throw
3404  * exceptions.
3405  * Capability check has been done in comment->check_permissions(), we
3406  * don't need to do it again here.
3407  *
3408  * @package  mod_data
3409  * @category comment
3410  *
3411  * @param stdClass $comment_param {
3412  *              context  => context the context object
3413  *              courseid => int course id
3414  *              cm       => stdClass course module object
3415  *              commentarea => string comment area
3416  *              itemid      => int itemid
3417  * }
3418  * @return array
3419  */
3420 function data_comment_permissions($comment_param) {
3421     global $CFG, $DB;
3422     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3423         throw new comment_exception('invalidcommentitemid');
3424     }
3425     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3426         throw new comment_exception('invalidid', 'data');
3427     }
3428     if ($data->comments) {
3429         return array('post'=>true, 'view'=>true);
3430     } else {
3431         return array('post'=>false, 'view'=>false);
3432     }
3435 /**
3436  * Validate comment parameter before perform other comments actions
3437  *
3438  * @package  mod_data
3439  * @category comment
3440  *
3441  * @param stdClass $comment_param {
3442  *              context  => context the context object
3443  *              courseid => int course id
3444  *              cm       => stdClass course module object
3445  *              commentarea => string comment area
3446  *              itemid      => int itemid
3447  * }
3448  * @return boolean
3449  */
3450 function data_comment_validate($comment_param) {
3451     global $DB;
3452     // validate comment area
3453     if ($comment_param->commentarea != 'database_entry') {
3454         throw new comment_exception('invalidcommentarea');
3455     }
3456     // validate itemid
3457     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3458         throw new comment_exception('invalidcommentitemid');
3459     }
3460     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3461         throw new comment_exception('invalidid', 'data');
3462     }
3463     if (!$course = $DB->get_record('course', array('id'=>$data->course))) {
3464         throw new comment_exception('coursemisconf');
3465     }
3466     if (!$cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
3467         throw new comment_exception('invalidcoursemodule');
3468     }
3469     if (!$data->comments) {
3470         throw new comment_exception('commentsoff', 'data');
3471     }
3472     $context = context_module::instance($cm->id);
3474     //check if approved
3475     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3476         throw new comment_exception('notapproved', 'data');
3477     }
3479     // group access
3480     if ($record->groupid) {
3481         $groupmode = groups_get_activity_groupmode($cm, $course);
3482         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3483             if (!groups_is_member($record->groupid)) {
3484                 throw new comment_exception('notmemberofgroup');
3485             }
3486         }
3487     }
3488     // validate context id
3489     if ($context->id != $comment_param->context->id) {
3490         throw new comment_exception('invalidcontext');
3491     }
3492     // validation for comment deletion
3493     if (!empty($comment_param->commentid)) {
3494         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3495             if ($comment->commentarea != 'database_entry') {
3496                 throw new comment_exception('invalidcommentarea');
3497             }
3498             if ($comment->contextid != $comment_param->context->id) {
3499                 throw new comment_exception('invalidcontext');
3500             }
3501             if ($comment->itemid != $comment_param->itemid) {
3502                 throw new comment_exception('invalidcommentitemid');
3503             }
3504         } else {
3505             throw new comment_exception('invalidcommentid');
3506         }
3507     }
3508     return true;
3511 /**
3512  * Return a list of page types
3513  * @param string $pagetype current page type
3514  * @param stdClass $parentcontext Block's parent context
3515  * @param stdClass $currentcontext Current context of block
3516  */
3517 function data_page_type_list($pagetype, $parentcontext, $currentcontext) {
3518     $module_pagetype = array('mod-data-*'=>get_string('page-mod-data-x', 'data'));
3519     return $module_pagetype;
3522 /**
3523  * Get all of the record ids from a database activity.
3524  *
3525  * @param int    $dataid      The dataid of the database module.
3526  * @param object $selectdata  Contains an additional sql statement for the
3527  *                            where clause for group and approval fields.
3528  * @param array  $params      Parameters that coincide with the sql statement.
3529  * @return array $idarray     An array of record ids
3530  */
3531 function data_get_all_recordids($dataid, $selectdata = '', $params = null) {
3532     global $DB;
3533     $initsql = 'SELECT r.id
3534                   FROM {data_records} r
3535                  WHERE r.dataid = :dataid';
3536     if ($selectdata != '') {
3537         $initsql .= $selectdata;
3538         $params = array_merge(array('dataid' => $dataid), $params);
3539     } else {
3540         $params = array('dataid' => $dataid);
3541     }
3542     $initsql .= ' GROUP BY r.id';
3543     $initrecord = $DB->get_recordset_sql($initsql, $params);
3544     $idarray = array();
3545     foreach ($initrecord as $data) {
3546         $idarray[] = $data->id;
3547     }
3548     // Close the record set and free up resources.
3549     $initrecord->close();
3550     return $idarray;
3553 /**
3554  * Get the ids of all the records that match that advanced search criteria
3555  * This goes and loops through each criterion one at a time until it either
3556  * runs out of records or returns a subset of records.
3557  *
3558  * @param array $recordids    An array of record ids.
3559  * @param array $searcharray  Contains information for the advanced search criteria
3560  * @param int $dataid         The data id of the database.
3561  * @return array $recordids   An array of record ids.
3562  */
3563 function data_get_advance_search_ids($recordids, $searcharray, $dataid) {
3564     $searchcriteria = array_keys($searcharray);
3565     // Loop through and reduce the IDs one search criteria at a time.
3566     foreach ($searchcriteria as $key) {
3567         $recordids = data_get_recordids($key, $searcharray, $dataid, $recordids);
3568         // If we don't have anymore IDs then stop.
3569         if (!$recordids) {
3570             break;
3571         }
3572     }
3573     return $recordids;
3576 /**
3577  * Gets the record IDs given the search criteria
3578  *
3579  * @param string $alias       Record alias.
3580  * @param array $searcharray  Criteria for the search.
3581  * @param int $dataid         Data ID for the database
3582  * @param array $recordids    An array of record IDs.
3583  * @return array $nestarray   An arry of record IDs
3584  */
3585 function data_get_recordids($alias, $searcharray, $dataid, $recordids) {
3586     global $DB;
3588     $nestsearch = $searcharray[$alias];
3589     // searching for content outside of mdl_data_content
3590     if ($alias < 0) {
3591         $alias = '';
3592     }
3593     list($insql, $params) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3594     $nestselect = 'SELECT c' . $alias . '.recordid
3595                      FROM {data_content} c' . $alias . ',
3596                           {data_fields} f,
3597                           {data_records} r,
3598                           {user} u ';
3599     $nestwhere = 'WHERE u.id = r.userid
3600                     AND f.id = c' . $alias . '.fieldid
3601                     AND r.id = c' . $alias . '.recordid
3602                     AND r.dataid = :dataid
3603                     AND c' . $alias .'.recordid ' . $insql . '
3604                     AND ';
3606     $params['dataid'] = $dataid;
3607     if (count($nestsearch->params) != 0) {
3608         $params = array_merge($params, $nestsearch->params);
3609         $nestsql = $nestselect . $nestwhere . $nestsearch->sql;
3610     } else {
3611         $thing = $DB->sql_like($nestsearch->field, ':search1', false);
3612         $nestsql = $nestselect . $nestwhere . $thing . ' GROUP BY c' . $alias . '.recordid';
3613         $params['search1'] = "%$nestsearch->data%";
3614     }
3615     $nestrecords = $DB->get_recordset_sql($nestsql, $params);
3616     $nestarray = array();
3617     foreach ($nestrecords as $data) {
3618         $nestarray[] = $data->recordid;
3619     }
3620     // Close the record set and free up resources.
3621     $nestrecords->close();
3622     return $nestarray;
3625 /**
3626  * Returns an array with an sql string for advanced searches and the parameters that go with them.
3627  *
3628  * @param int $sort            DATA_*
3629  * @param stdClass $data       Data module object
3630  * @param array $recordids     An array of record IDs.
3631  * @param string $selectdata   Information for the where and select part of the sql statement.
3632  * @param string $sortorder    Additional sort parameters
3633  * @return array sqlselect     sqlselect['sql'] has the sql string, sqlselect['params'] contains an array of parameters.
3634  */
3635 function data_get_advanced_search_sql($sort, $data, $recordids, $selectdata, $sortorder) {
3636     global $DB;
3638     $namefields = user_picture::fields('u');
3639     // Remove the id from the string. This already exists in the sql statement.
3640     $namefields = str_replace('u.id,', '', $namefields);
3642     if ($sort == 0) {
3643         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . '
3644                         FROM {data_content} c,
3645                              {data_records} r,
3646                              {user} u ';
3647         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' . $namefields;
3648     } else {
3649         // Sorting through 'Other' criteria
3650         if ($sort <= 0) {
3651             switch ($sort) {
3652                 case DATA_LASTNAME:
3653                     $sortcontentfull = "u.lastname";
3654                     break;
3655                 case DATA_FIRSTNAME:
3656                     $sortcontentfull = "u.firstname";
3657                     break;
3658                 case DATA_APPROVED:
3659                     $sortcontentfull = "r.approved";
3660                     break;
3661                 case DATA_TIMEMODIFIED:
3662                     $sortcontentfull = "r.timemodified";
3663                     break;
3664                 case DATA_TIMEADDED:
3665                 default:
3666                     $sortcontentfull = "r.timecreated";
3667             }
3668         } else {
3669             $sortfield = data_get_field_from_id($sort, $data);
3670             $sortcontent = $DB->sql_compare_text('c.' . $sortfield->get_sort_field());
3671             $sortcontentfull = $sortfield->get_sort_sql($sortcontent);
3672         }
3674         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . ',
3675                                  ' . $sortcontentfull . '
3676                               AS sortorder
3677                             FROM {data_content} c,
3678                                  {data_records} r,
3679                                  {user} u ';
3680         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . ', ' .$sortcontentfull;
3681     }
3683     // Default to a standard Where statement if $selectdata is empty.
3684     if ($selectdata == '') {
3685         $selectdata = 'WHERE c.recordid = r.id
3686                          AND r.dataid = :dataid
3687                          AND r.userid = u.id ';
3688     }
3690     // Find the field we are sorting on
3691     if ($sort > 0 or data_get_field_from_id($sort, $data)) {
3692         $selectdata .= ' AND c.fieldid = :sort';
3693     }
3695     // If there are no record IDs then return an sql statment that will return no rows.
3696     if (count($recordids) != 0) {
3697         list($insql, $inparam) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3698     } else {
3699         list($insql, $inparam) = $DB->get_in_or_equal(array('-1'), SQL_PARAMS_NAMED);
3700     }
3701     $nestfromsql = $selectdata . ' AND c.recordid ' . $insql . $groupsql;
3702     $sqlselect['sql'] = "$nestselectsql $nestfromsql $sortorder";
3703     $sqlselect['params'] = $inparam;
3704     return $sqlselect;
3707 /**
3708  * Checks to see if the user has permission to delete the preset.
3709  * @param stdClass $context  Context object.
3710  * @param stdClass $preset  The preset object that we are checking for deletion.
3711  * @return bool  Returns true if the user can delete, otherwise false.
3712  */
3713 function data_user_can_delete_preset($context, $preset) {
3714     global $USER;
3716     if (has_capability('mod/data:manageuserpresets', $context)) {
3717         return true;
3718     } else {
3719         $candelete = false;
3720         if ($preset->userid == $USER->id) {
3721             $candelete = true;
3722         }
3723         return $candelete;
3724     }
3727 /**
3728  * Delete a record entry.
3729  *
3730  * @param int $recordid The ID for the record to be deleted.
3731  * @param object $data The data object for this activity.
3732  * @param int $courseid ID for the current course (for logging).
3733  * @param int $cmid The course module ID.
3734  * @return bool True if the record deleted, false if not.
3735  */
3736 function data_delete_record($recordid, $data, $courseid, $cmid) {
3737     global $DB, $CFG;
3739     if ($deleterecord = $DB->get_record('data_records', array('id' => $recordid))) {
3740         if ($deleterecord->dataid == $data->id) {
3741             if ($contents = $DB->get_records('data_content', array('recordid' => $deleterecord->id))) {
3742                 foreach ($contents as $content) {
3743                     if ($field = data_get_field_from_id($content->fieldid, $data)) {
3744                         $field->delete_content($content->recordid);
3745                     }
3746                 }
3747                 $DB->delete_records('data_content', array('recordid'=>$deleterecord->id));
3748                 $DB->delete_records('data_records', array('id'=>$deleterecord->id));
3750                 // Delete cached RSS feeds.
3751                 if (!empty($CFG->enablerssfeeds)) {
3752                     require_once($CFG->dirroot.'/mod/data/rsslib.php');
3753                     data_rss_delete_file($data);
3754                 }
3756                 // Trigger an event for deleting this record.
3757                 $event = \mod_data\event\record_deleted::create(array(
3758                     'objectid' => $deleterecord->id,
3759                     'context' => context_module::instance($cmid),
3760                     'courseid' => $courseid,
3761                     'other' => array(
3762                         'dataid' => $deleterecord->dataid
3763                     )
3764                 ));
3765                 $event->add_record_snapshot('data_records', $deleterecord);
3766                 $event->trigger();
3768                 return true;
3769             }
3770         }
3771     }
3772     return false;
3775 /**
3776  * Check for required fields, and build a list of fields to be updated in a
3777  * submission.
3778  *
3779  * @param $mod stdClass The current recordid - provided as an optimisation.
3780  * @param $fields array The field data
3781  * @param $datarecord stdClass The submitted data.
3782  * @return stdClass containing:
3783  * * string[] generalnotifications Notifications for the form as a whole.
3784  * * string[] fieldnotifications Notifications for a specific field.
3785  * * bool validated Whether the field was validated successfully.
3786  * * data_field_base[] fields The field objects to be update.
3787  */
3788 function data_process_submission(stdClass $mod, $fields, stdClass $datarecord) {
3789     $result = new stdClass();
3791     // Empty form checking - you can't submit an empty form.
3792     $emptyform = true;
3793     $requiredfieldsfilled = true;
3795     // Store the notifications.
3796     $result->generalnotifications = array();
3797     $result->fieldnotifications = array();
3799     // Store the instantiated classes as an optimisation when processing the result.
3800     // This prevents the fields being re-initialised when updating.
3801     $result->fields = array();
3803     $submitteddata = array();
3804     foreach ($datarecord as $fieldname => $fieldvalue) {
3805         if (strpos($fieldname, '_')) {
3806             $namearray = explode('_', $fieldname, 3);
3807             $fieldid = $namearray[1];
3808             if (!isset($submitteddata[$fieldid])) {
3809                 $submitteddata[$fieldid] = array();
3810             }
3811             if (count($namearray) === 2) {
3812                 $subfieldid = 0;
3813             } else {
3814                 $subfieldid = $namearray[2];
3815             }
3817             $fielddata = new stdClass();
3818             $fielddata->fieldname = $fieldname;
3819             $fielddata->value = $fieldvalue;
3820             $submitteddata[$fieldid][$subfieldid] = $fielddata;
3821         }
3822     }
3824     // Check all form fields which have the required are filled.
3825     foreach ($fields as $fieldrecord) {
3826         // Check whether the field has any data.
3827         $fieldhascontent = false;
3829         $field = data_get_field($fieldrecord, $mod);
3830         if (isset($submitteddata[$fieldrecord->id])) {
3831             foreach ($submitteddata[$fieldrecord->id] as $fieldname => $value) {
3832                 if ($field->notemptyfield($value->value, $value->fieldname)) {
3833                     // The field has content and the form is not empty.
3834                     $fieldhascontent = true;
3835                     $emptyform = false;
3836                 }
3837             }
3838         }
3840         // If the field is required, add a notification to that effect.
3841         if ($field->field->required && !$fieldhascontent) {
3842             if (!isset($result->fieldnotifications[$field->field->name])) {
3843                 $result->fieldnotifications[$field->field->name] = array();
3844             }
3845             $result->fieldnotifications[$field->field->name][] = get_string('errormustsupplyvalue', 'data');
3846             $requiredfieldsfilled = false;
3847         }
3849         // Update the field.
3850         if (isset($submitteddata[$fieldrecord->id])) {
3851             foreach ($submitteddata[$fieldrecord->id] as $value) {
3852                 $result->fields[$value->fieldname] = $field;
3853             }
3854         }
3855     }
3857     if ($emptyform) {
3858         // The form is empty.
3859         $result->generalnotifications[] = get_string('emptyaddform', 'data');
3860     }
3862     $result->validated = $requiredfieldsfilled && !$emptyform;
3864     return $result;