37519ceb2fdab3f1dff2374012539e9bf10a19e7
[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 defined('MOODLE_INTERNAL') || die();
26 // Some constants
27 define ('DATA_MAX_ENTRIES', 50);
28 define ('DATA_PERPAGE_SINGLE', 1);
30 define ('DATA_FIRSTNAME', -1);
31 define ('DATA_LASTNAME', -2);
32 define ('DATA_APPROVED', -3);
33 define ('DATA_TIMEADDED', 0);
34 define ('DATA_TIMEMODIFIED', -4);
35 define ('DATA_TAGS', -5);
37 define ('DATA_CAP_EXPORT', 'mod/data:viewalluserpresets');
39 define('DATA_PRESET_COMPONENT', 'mod_data');
40 define('DATA_PRESET_FILEAREA', 'site_presets');
41 define('DATA_PRESET_CONTEXT', SYSCONTEXTID);
43 define('DATA_EVENT_TYPE_OPEN', 'open');
44 define('DATA_EVENT_TYPE_CLOSE', 'close');
46 // Users having assigned the default role "Non-editing teacher" can export database records
47 // Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
48 // In Moodle >= 2, new roles may be introduced and used instead.
50 /**
51  * @package   mod_data
52  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
53  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
54  */
55 class data_field_base {     // Base class for Database Field Types (see field/*/field.class.php)
57     /** @var string Subclasses must override the type with their name */
58     var $type = 'unknown';
59     /** @var object The database object that this field belongs to */
60     var $data = NULL;
61     /** @var object The field object itself, if we know it */
62     var $field = NULL;
63     /** @var int Width of the icon for this fieldtype */
64     var $iconwidth = 16;
65     /** @var int Width of the icon for this fieldtype */
66     var $iconheight = 16;
67     /** @var object course module or cmifno */
68     var $cm;
69     /** @var object activity context */
70     var $context;
71     /** @var priority for globalsearch indexing */
72     protected static $priority = self::NO_PRIORITY;
73     /** priority value for invalid fields regarding indexing */
74     const NO_PRIORITY = 0;
75     /** priority value for minimum priority */
76     const MIN_PRIORITY = 1;
77     /** priority value for low priority */
78     const LOW_PRIORITY = 2;
79     /** priority value for high priority */
80     const HIGH_PRIORITY = 3;
81     /** priority value for maximum priority */
82     const MAX_PRIORITY = 4;
84     /**
85      * Constructor function
86      *
87      * @global object
88      * @uses CONTEXT_MODULE
89      * @param int $field
90      * @param int $data
91      * @param int $cm
92      */
93     function __construct($field=0, $data=0, $cm=0) {   // Field or data or both, each can be id or object
94         global $DB;
96         if (empty($field) && empty($data)) {
97             print_error('missingfield', 'data');
98         }
100         if (!empty($field)) {
101             if (is_object($field)) {
102                 $this->field = $field;  // Programmer knows what they are doing, we hope
103             } else if (!$this->field = $DB->get_record('data_fields', array('id'=>$field))) {
104                 print_error('invalidfieldid', 'data');
105             }
106             if (empty($data)) {
107                 if (!$this->data = $DB->get_record('data', array('id'=>$this->field->dataid))) {
108                     print_error('invalidid', 'data');
109                 }
110             }
111         }
113         if (empty($this->data)) {         // We need to define this properly
114             if (!empty($data)) {
115                 if (is_object($data)) {
116                     $this->data = $data;  // Programmer knows what they are doing, we hope
117                 } else if (!$this->data = $DB->get_record('data', array('id'=>$data))) {
118                     print_error('invalidid', 'data');
119                 }
120             } else {                      // No way to define it!
121                 print_error('missingdata', 'data');
122             }
123         }
125         if ($cm) {
126             $this->cm = $cm;
127         } else {
128             $this->cm = get_coursemodule_from_instance('data', $this->data->id);
129         }
131         if (empty($this->field)) {         // We need to define some default values
132             $this->define_default_field();
133         }
135         $this->context = context_module::instance($this->cm->id);
136     }
139     /**
140      * This field just sets up a default field object
141      *
142      * @return bool
143      */
144     function define_default_field() {
145         global $OUTPUT;
146         if (empty($this->data->id)) {
147             echo $OUTPUT->notification('Programmer error: dataid not defined in field class');
148         }
149         $this->field = new stdClass();
150         $this->field->id = 0;
151         $this->field->dataid = $this->data->id;
152         $this->field->type   = $this->type;
153         $this->field->param1 = '';
154         $this->field->param2 = '';
155         $this->field->param3 = '';
156         $this->field->name = '';
157         $this->field->description = '';
158         $this->field->required = false;
160         return true;
161     }
163     /**
164      * Set up the field object according to data in an object.  Now is the time to clean it!
165      *
166      * @return bool
167      */
168     function define_field($data) {
169         $this->field->type        = $this->type;
170         $this->field->dataid      = $this->data->id;
172         $this->field->name        = trim($data->name);
173         $this->field->description = trim($data->description);
174         $this->field->required    = !empty($data->required) ? 1 : 0;
176         if (isset($data->param1)) {
177             $this->field->param1 = trim($data->param1);
178         }
179         if (isset($data->param2)) {
180             $this->field->param2 = trim($data->param2);
181         }
182         if (isset($data->param3)) {
183             $this->field->param3 = trim($data->param3);
184         }
185         if (isset($data->param4)) {
186             $this->field->param4 = trim($data->param4);
187         }
188         if (isset($data->param5)) {
189             $this->field->param5 = trim($data->param5);
190         }
192         return true;
193     }
195     /**
196      * Insert a new field in the database
197      * We assume the field object is already defined as $this->field
198      *
199      * @global object
200      * @return bool
201      */
202     function insert_field() {
203         global $DB, $OUTPUT;
205         if (empty($this->field)) {
206             echo $OUTPUT->notification('Programmer error: Field has not been defined yet!  See define_field()');
207             return false;
208         }
210         $this->field->id = $DB->insert_record('data_fields',$this->field);
212         // Trigger an event for creating this field.
213         $event = \mod_data\event\field_created::create(array(
214             'objectid' => $this->field->id,
215             'context' => $this->context,
216             'other' => array(
217                 'fieldname' => $this->field->name,
218                 'dataid' => $this->data->id
219             )
220         ));
221         $event->trigger();
223         return true;
224     }
227     /**
228      * Update a field in the database
229      *
230      * @global object
231      * @return bool
232      */
233     function update_field() {
234         global $DB;
236         $DB->update_record('data_fields', $this->field);
238         // Trigger an event for updating this field.
239         $event = \mod_data\event\field_updated::create(array(
240             'objectid' => $this->field->id,
241             'context' => $this->context,
242             'other' => array(
243                 'fieldname' => $this->field->name,
244                 'dataid' => $this->data->id
245             )
246         ));
247         $event->trigger();
249         return true;
250     }
252     /**
253      * Delete a field completely
254      *
255      * @global object
256      * @return bool
257      */
258     function delete_field() {
259         global $DB;
261         if (!empty($this->field->id)) {
262             // Get the field before we delete it.
263             $field = $DB->get_record('data_fields', array('id' => $this->field->id));
265             $this->delete_content();
266             $DB->delete_records('data_fields', array('id'=>$this->field->id));
268             // Trigger an event for deleting this field.
269             $event = \mod_data\event\field_deleted::create(array(
270                 'objectid' => $this->field->id,
271                 'context' => $this->context,
272                 'other' => array(
273                     'fieldname' => $this->field->name,
274                     'dataid' => $this->data->id
275                  )
276             ));
277             $event->add_record_snapshot('data_fields', $field);
278             $event->trigger();
279         }
281         return true;
282     }
284     /**
285      * Print the relevant form element in the ADD template for this field
286      *
287      * @global object
288      * @param int $recordid
289      * @return string
290      */
291     function display_add_field($recordid=0, $formdata=null) {
292         global $DB, $OUTPUT;
294         if ($formdata) {
295             $fieldname = 'field_' . $this->field->id;
296             $content = $formdata->$fieldname;
297         } else if ($recordid) {
298             $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
299         } else {
300             $content = '';
301         }
303         // beware get_field returns false for new, empty records MDL-18567
304         if ($content===false) {
305             $content='';
306         }
308         $str = '<div title="' . s($this->field->description) . '">';
309         $str .= '<label for="field_'.$this->field->id.'"><span class="accesshide">'.$this->field->name.'</span>';
310         if ($this->field->required) {
311             $image = $OUTPUT->pix_icon('req', get_string('requiredelement', 'form'));
312             $str .= html_writer::div($image, 'inline-req');
313         }
314         $str .= '</label><input class="basefieldinput form-control d-inline mod-data-input" ' .
315                 'type="text" name="field_' . $this->field->id . '" ' .
316                 'id="field_' . $this->field->id . '" value="' . s($content) . '" />';
317         $str .= '</div>';
319         return $str;
320     }
322     /**
323      * Print the relevant form element to define the attributes for this field
324      * viewable by teachers only.
325      *
326      * @global object
327      * @global object
328      * @return void Output is echo'd
329      */
330     function display_edit_field() {
331         global $CFG, $DB, $OUTPUT;
333         if (empty($this->field)) {   // No field has been defined yet, try and make one
334             $this->define_default_field();
335         }
336         echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
338         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
339         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
340         if (empty($this->field->id)) {
341             echo '<input type="hidden" name="mode" value="add" />'."\n";
342             $savebutton = get_string('add');
343         } else {
344             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
345             echo '<input type="hidden" name="mode" value="update" />'."\n";
346             $savebutton = get_string('savechanges');
347         }
348         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
349         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
351         echo $OUTPUT->heading($this->name(), 3);
353         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
355         echo '<div class="mdl-align">';
356         echo '<input type="submit" class="btn btn-primary" value="'.$savebutton.'" />'."\n";
357         echo '<input type="submit" class="btn btn-secondary" name="cancel" value="'.get_string('cancel').'" />'."\n";
358         echo '</div>';
360         echo '</form>';
362         echo $OUTPUT->box_end();
363     }
365     /**
366      * Display the content of the field in browse mode
367      *
368      * @global object
369      * @param int $recordid
370      * @param object $template
371      * @return bool|string
372      */
373     function display_browse_field($recordid, $template) {
374         global $DB;
376         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
377             if (isset($content->content)) {
378                 $options = new stdClass();
379                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
380                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
381                     //$content->content1 = FORMAT_HTML;
382                     $options->filter=false;
383                 }
384                 $options->para = false;
385                 $str = format_text($content->content, $content->content1, $options);
386             } else {
387                 $str = '';
388             }
389             return $str;
390         }
391         return false;
392     }
394     /**
395      * Update the content of one data field in the data_content table
396      * @global object
397      * @param int $recordid
398      * @param mixed $value
399      * @param string $name
400      * @return bool
401      */
402     function update_content($recordid, $value, $name=''){
403         global $DB;
405         $content = new stdClass();
406         $content->fieldid = $this->field->id;
407         $content->recordid = $recordid;
408         $content->content = clean_param($value, PARAM_NOTAGS);
410         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
411             $content->id = $oldcontent->id;
412             return $DB->update_record('data_content', $content);
413         } else {
414             return $DB->insert_record('data_content', $content);
415         }
416     }
418     /**
419      * Delete all content associated with the field
420      *
421      * @global object
422      * @param int $recordid
423      * @return bool
424      */
425     function delete_content($recordid=0) {
426         global $DB;
428         if ($recordid) {
429             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
430         } else {
431             $conditions = array('fieldid'=>$this->field->id);
432         }
434         $rs = $DB->get_recordset('data_content', $conditions);
435         if ($rs->valid()) {
436             $fs = get_file_storage();
437             foreach ($rs as $content) {
438                 $fs->delete_area_files($this->context->id, 'mod_data', 'content', $content->id);
439             }
440         }
441         $rs->close();
443         return $DB->delete_records('data_content', $conditions);
444     }
446     /**
447      * Check if a field from an add form is empty
448      *
449      * @param mixed $value
450      * @param mixed $name
451      * @return bool
452      */
453     function notemptyfield($value, $name) {
454         return !empty($value);
455     }
457     /**
458      * Just in case a field needs to print something before the whole form
459      */
460     function print_before_form() {
461     }
463     /**
464      * Just in case a field needs to print something after the whole form
465      */
466     function print_after_form() {
467     }
470     /**
471      * Returns the sortable field for the content. By default, it's just content
472      * but for some plugins, it could be content 1 - content4
473      *
474      * @return string
475      */
476     function get_sort_field() {
477         return 'content';
478     }
480     /**
481      * Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
482      *
483      * @param string $fieldname
484      * @return string $fieldname
485      */
486     function get_sort_sql($fieldname) {
487         return $fieldname;
488     }
490     /**
491      * Returns the name/type of the field
492      *
493      * @return string
494      */
495     function name() {
496         return get_string('fieldtypelabel', "datafield_$this->type");
497     }
499     /**
500      * Prints the respective type icon
501      *
502      * @global object
503      * @return string
504      */
505     function image() {
506         global $OUTPUT;
508         $params = array('d'=>$this->data->id, 'fid'=>$this->field->id, 'mode'=>'display', 'sesskey'=>sesskey());
509         $link = new moodle_url('/mod/data/field.php', $params);
510         $str = '<a href="'.$link->out().'">';
511         $str .= $OUTPUT->pix_icon('field/' . $this->type, $this->type, 'data');
512         $str .= '</a>';
513         return $str;
514     }
516     /**
517      * Per default, it is assumed that fields support text exporting.
518      * Override this (return false) on fields not supporting text exporting.
519      *
520      * @return bool true
521      */
522     function text_export_supported() {
523         return true;
524     }
526     /**
527      * Per default, return the record's text value only from the "content" field.
528      * Override this in fields class if necesarry.
529      *
530      * @param string $record
531      * @return string
532      */
533     function export_text_value($record) {
534         if ($this->text_export_supported()) {
535             return $record->content;
536         }
537     }
539     /**
540      * @param string $relativepath
541      * @return bool false
542      */
543     function file_ok($relativepath) {
544         return false;
545     }
547     /**
548      * Returns the priority for being indexed by globalsearch
549      *
550      * @return int
551      */
552     public static function get_priority() {
553         return static::$priority;
554     }
556     /**
557      * Returns the presentable string value for a field content.
558      *
559      * The returned string should be plain text.
560      *
561      * @param stdClass $content
562      * @return string
563      */
564     public static function get_content_value($content) {
565         return trim($content->content, "\r\n ");
566     }
568     /**
569      * Return the plugin configs for external functions,
570      * in some cases the configs will need formatting or be returned only if the current user has some capabilities enabled.
571      *
572      * @return array the list of config parameters
573      * @since Moodle 3.3
574      */
575     public function get_config_for_external() {
576         // Return all the field configs to null (maybe there is a private key for a service or something similar there).
577         $configs = [];
578         for ($i = 1; $i <= 10; $i++) {
579             $configs["param$i"] = null;
580         }
581         return $configs;
582     }
586 /**
587  * Given a template and a dataid, generate a default case template
588  *
589  * @global object
590  * @param object $data
591  * @param string template [addtemplate, singletemplate, listtempalte, rsstemplate]
592  * @param int $recordid
593  * @param bool $form
594  * @param bool $update
595  * @return bool|string
596  */
597 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
598     global $DB;
600     if (!$data && !$template) {
601         return false;
602     }
603     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
604         return '';
605     }
607     // get all the fields for that database
608     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
610         $table = new html_table();
611         $table->attributes['class'] = 'mod-data-default-template ##approvalstatus##';
612         $table->colclasses = array('template-field', 'template-token');
613         $table->data = array();
614         foreach ($fields as $field) {
615             if ($form) {   // Print forms instead of data
616                 $fieldobj = data_get_field($field, $data);
617                 $token = $fieldobj->display_add_field($recordid, null);
618             } else {           // Just print the tag
619                 $token = '[['.$field->name.']]';
620             }
621             $table->data[] = array(
622                 $field->name.': ',
623                 $token
624             );
625         }
627         if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
628             $label = new html_table_cell(get_string('tags') . ':');
629             if ($form) {
630                 $cell = data_generate_tag_form();
631             } else {
632                 $cell = new html_table_cell('##tags##');
633             }
634             $table->data[] = new html_table_row(array($label, $cell));
635         }
637         if ($template == 'listtemplate') {
638             $cell = new html_table_cell('##edit##  ##more##  ##delete##  ##approve##  ##disapprove##  ##export##');
639             $cell->colspan = 2;
640             $cell->attributes['class'] = 'controls';
641             $table->data[] = new html_table_row(array($cell));
642         } else if ($template == 'singletemplate') {
643             $cell = new html_table_cell('##edit##  ##delete##  ##approve##  ##disapprove##  ##export##');
644             $cell->colspan = 2;
645             $cell->attributes['class'] = 'controls';
646             $table->data[] = new html_table_row(array($cell));
647         } else if ($template == 'asearchtemplate') {
648             $row = new html_table_row(array(get_string('authorfirstname', 'data').': ', '##firstname##'));
649             $row->attributes['class'] = 'searchcontrols';
650             $table->data[] = $row;
651             $row = new html_table_row(array(get_string('authorlastname', 'data').': ', '##lastname##'));
652             $row->attributes['class'] = 'searchcontrols';
653             $table->data[] = $row;
654         }
656         $str = '';
657         if ($template == 'listtemplate'){
658             $str .= '##delcheck##';
659             $str .= html_writer::empty_tag('br');
660         }
662         $str .= html_writer::start_tag('div', array('class' => 'defaulttemplate'));
663         $str .= html_writer::table($table);
664         $str .= html_writer::end_tag('div');
665         if ($template == 'listtemplate'){
666             $str .= html_writer::empty_tag('hr');
667         }
669         if ($update) {
670             $newdata = new stdClass();
671             $newdata->id = $data->id;
672             $newdata->{$template} = $str;
673             $DB->update_record('data', $newdata);
674             $data->{$template} = $str;
675         }
677         return $str;
678     }
681 /**
682  * Build the form elements to manage tags for a record.
683  *
684  * @param int|bool $recordid
685  * @param string[] $selected raw tag names
686  * @return string
687  */
688 function data_generate_tag_form($recordid = false, $selected = []) {
689     global $CFG, $DB, $OUTPUT, $PAGE;
691     $tagtypestoshow = \core_tag_area::get_showstandard('mod_data', 'data_records');
692     $showstandard = ($tagtypestoshow != core_tag_tag::HIDE_STANDARD);
693     $typenewtags = ($tagtypestoshow != core_tag_tag::STANDARD_ONLY);
695     $str = html_writer::start_tag('div', array('class' => 'datatagcontrol'));
697     $namefield = empty($CFG->keeptagnamecase) ? 'name' : 'rawname';
699     $tagcollid = \core_tag_area::get_collection('mod_data', 'data_records');
700     $tags = [];
701     $selectedtags = [];
703     if ($showstandard) {
704         $tags += $DB->get_records_menu('tag', array('isstandard' => 1, 'tagcollid' => $tagcollid),
705             $namefield, 'id,' . $namefield . ' as fieldname');
706     }
708     if ($recordid) {
709         $selectedtags += core_tag_tag::get_item_tags_array('mod_data', 'data_records', $recordid);
710     }
712     if (!empty($selected)) {
713         list($sql, $params) = $DB->get_in_or_equal($selected, SQL_PARAMS_NAMED);
714         $params['tagcollid'] = $tagcollid;
715         $sql = "SELECT id, $namefield FROM {tag} WHERE tagcollid = :tagcollid AND rawname $sql";
716         $selectedtags += $DB->get_records_sql_menu($sql, $params);
717     }
719     $tags += $selectedtags;
721     $str .= '<select class="custom-select" name="tags[]" id="tags" multiple>';
722     foreach ($tags as $tagid => $tag) {
723         $selected = key_exists($tagid, $selectedtags) ? 'selected' : '';
724         $str .= "<option value='$tag' $selected>$tag</option>";
725     }
726     $str .= '</select>';
728     if (has_capability('moodle/tag:manage', context_system::instance()) && $showstandard) {
729         $url = new moodle_url('/tag/manage.php', array('tc' => core_tag_area::get_collection('mod_data',
730             'data_records')));
731         $str .= ' ' . $OUTPUT->action_link($url, get_string('managestandardtags', 'tag'));
732     }
734     $PAGE->requires->js_call_amd('core/form-autocomplete', 'enhance', $params = array(
735             '#tags',
736             $typenewtags,
737             '',
738             get_string('entertags', 'tag'),
739             false,
740             $showstandard,
741             get_string('noselection', 'form')
742         )
743     );
745     $str .= html_writer::end_tag('div');
747     return $str;
751 /**
752  * Search for a field name and replaces it with another one in all the
753  * form templates. Set $newfieldname as '' if you want to delete the
754  * field from the form.
755  *
756  * @global object
757  * @param object $data
758  * @param string $searchfieldname
759  * @param string $newfieldname
760  * @return bool
761  */
762 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
763     global $DB;
765     if (!empty($newfieldname)) {
766         $prestring = '[[';
767         $poststring = ']]';
768         $idpart = '#id';
770     } else {
771         $prestring = '';
772         $poststring = '';
773         $idpart = '';
774     }
776     $newdata = new stdClass();
777     $newdata->id = $data->id;
778     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
779             $prestring.$newfieldname.$poststring, $data->singletemplate);
781     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
782             $prestring.$newfieldname.$poststring, $data->listtemplate);
784     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
785             $prestring.$newfieldname.$poststring, $data->addtemplate);
787     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
788             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
790     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
791             $prestring.$newfieldname.$poststring, $data->rsstemplate);
793     return $DB->update_record('data', $newdata);
797 /**
798  * Appends a new field at the end of the form template.
799  *
800  * @global object
801  * @param object $data
802  * @param string $newfieldname
803  */
804 function data_append_new_field_to_templates($data, $newfieldname) {
805     global $DB;
807     $newdata = new stdClass();
808     $newdata->id = $data->id;
809     $change = false;
811     if (!empty($data->singletemplate)) {
812         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
813         $change = true;
814     }
815     if (!empty($data->addtemplate)) {
816         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
817         $change = true;
818     }
819     if (!empty($data->rsstemplate)) {
820         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
821         $change = true;
822     }
823     if ($change) {
824         $DB->update_record('data', $newdata);
825     }
829 /**
830  * given a field name
831  * this function creates an instance of the particular subfield class
832  *
833  * @global object
834  * @param string $name
835  * @param object $data
836  * @return object|bool
837  */
838 function data_get_field_from_name($name, $data){
839     global $DB;
841     $field = $DB->get_record('data_fields', array('name'=>$name, 'dataid'=>$data->id));
843     if ($field) {
844         return data_get_field($field, $data);
845     } else {
846         return false;
847     }
850 /**
851  * given a field id
852  * this function creates an instance of the particular subfield class
853  *
854  * @global object
855  * @param int $fieldid
856  * @param object $data
857  * @return bool|object
858  */
859 function data_get_field_from_id($fieldid, $data){
860     global $DB;
862     $field = $DB->get_record('data_fields', array('id'=>$fieldid, 'dataid'=>$data->id));
864     if ($field) {
865         return data_get_field($field, $data);
866     } else {
867         return false;
868     }
871 /**
872  * given a field id
873  * this function creates an instance of the particular subfield class
874  *
875  * @global object
876  * @param string $type
877  * @param object $data
878  * @return object
879  */
880 function data_get_field_new($type, $data) {
881     global $CFG;
883     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
884     $newfield = 'data_field_'.$type;
885     $newfield = new $newfield(0, $data);
886     return $newfield;
889 /**
890  * returns a subclass field object given a record of the field, used to
891  * invoke plugin methods
892  * input: $param $field - record from db
893  *
894  * @global object
895  * @param object $field
896  * @param object $data
897  * @param object $cm
898  * @return object
899  */
900 function data_get_field($field, $data, $cm=null) {
901     global $CFG;
903     if ($field) {
904         require_once('field/'.$field->type.'/field.class.php');
905         $newfield = 'data_field_'.$field->type;
906         $newfield = new $newfield($field, $data, $cm);
907         return $newfield;
908     }
912 /**
913  * Given record object (or id), returns true if the record belongs to the current user
914  *
915  * @global object
916  * @global object
917  * @param mixed $record record object or id
918  * @return bool
919  */
920 function data_isowner($record) {
921     global $USER, $DB;
923     if (!isloggedin()) { // perf shortcut
924         return false;
925     }
927     if (!is_object($record)) {
928         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
929             return false;
930         }
931     }
933     return ($record->userid == $USER->id);
936 /**
937  * has a user reached the max number of entries?
938  *
939  * @param object $data
940  * @return bool
941  */
942 function data_atmaxentries($data){
943     if (!$data->maxentries){
944         return false;
946     } else {
947         return (data_numentries($data) >= $data->maxentries);
948     }
951 /**
952  * returns the number of entries already made by this user
953  *
954  * @global object
955  * @global object
956  * @param object $data
957  * @return int
958  */
959 function data_numentries($data, $userid=null) {
960     global $USER, $DB;
961     if ($userid === null) {
962         $userid = $USER->id;
963     }
964     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
965     return $DB->count_records_sql($sql, array($data->id, $userid));
968 /**
969  * function that takes in a dataid and adds a record
970  * this is used everytime an add template is submitted
971  *
972  * @global object
973  * @global object
974  * @param object $data
975  * @param int $groupid
976  * @return bool
977  */
978 function data_add_record($data, $groupid=0){
979     global $USER, $DB;
981     $cm = get_coursemodule_from_instance('data', $data->id);
982     $context = context_module::instance($cm->id);
984     $record = new stdClass();
985     $record->userid = $USER->id;
986     $record->dataid = $data->id;
987     $record->groupid = $groupid;
988     $record->timecreated = $record->timemodified = time();
989     if (has_capability('mod/data:approve', $context)) {
990         $record->approved = 1;
991     } else {
992         $record->approved = 0;
993     }
994     $record->id = $DB->insert_record('data_records', $record);
996     // Trigger an event for creating this record.
997     $event = \mod_data\event\record_created::create(array(
998         'objectid' => $record->id,
999         'context' => $context,
1000         'other' => array(
1001             'dataid' => $data->id
1002         )
1003     ));
1004     $event->trigger();
1006     $course = get_course($cm->course);
1007     data_update_completion_state($data, $course, $cm);
1009     return $record->id;
1012 /**
1013  * check the multple existence any tag in a template
1014  *
1015  * check to see if there are 2 or more of the same tag being used.
1016  *
1017  * @global object
1018  * @param int $dataid,
1019  * @param string $template
1020  * @return bool
1021  */
1022 function data_tags_check($dataid, $template) {
1023     global $DB, $OUTPUT;
1025     // first get all the possible tags
1026     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
1027     // then we generate strings to replace
1028     $tagsok = true; // let's be optimistic
1029     foreach ($fields as $field){
1030         $pattern="/\[\[" . preg_quote($field->name, '/') . "\]\]/i";
1031         if (preg_match_all($pattern, $template, $dummy)>1){
1032             $tagsok = false;
1033             echo $OUTPUT->notification('[['.$field->name.']] - '.get_string('multipletags','data'));
1034         }
1035     }
1036     // else return true
1037     return $tagsok;
1040 /**
1041  * Adds an instance of a data
1042  *
1043  * @param stdClass $data
1044  * @param mod_data_mod_form $mform
1045  * @return int intance id
1046  */
1047 function data_add_instance($data, $mform = null) {
1048     global $DB, $CFG;
1049     require_once($CFG->dirroot.'/mod/data/locallib.php');
1051     if (empty($data->assessed)) {
1052         $data->assessed = 0;
1053     }
1055     if (empty($data->ratingtime) || empty($data->assessed)) {
1056         $data->assesstimestart  = 0;
1057         $data->assesstimefinish = 0;
1058     }
1060     $data->timemodified = time();
1062     $data->id = $DB->insert_record('data', $data);
1064     // Add calendar events if necessary.
1065     data_set_events($data);
1066     if (!empty($data->completionexpected)) {
1067         \core_completion\api::update_completion_date_event($data->coursemodule, 'data', $data->id, $data->completionexpected);
1068     }
1070     data_grade_item_update($data);
1072     return $data->id;
1075 /**
1076  * updates an instance of a data
1077  *
1078  * @global object
1079  * @param object $data
1080  * @return bool
1081  */
1082 function data_update_instance($data) {
1083     global $DB, $CFG;
1084     require_once($CFG->dirroot.'/mod/data/locallib.php');
1086     $data->timemodified = time();
1087     $data->id           = $data->instance;
1089     if (empty($data->assessed)) {
1090         $data->assessed = 0;
1091     }
1093     if (empty($data->ratingtime) or empty($data->assessed)) {
1094         $data->assesstimestart  = 0;
1095         $data->assesstimefinish = 0;
1096     }
1098     if (empty($data->notification)) {
1099         $data->notification = 0;
1100     }
1102     $DB->update_record('data', $data);
1104     // Add calendar events if necessary.
1105     data_set_events($data);
1106     $completionexpected = (!empty($data->completionexpected)) ? $data->completionexpected : null;
1107     \core_completion\api::update_completion_date_event($data->coursemodule, 'data', $data->id, $completionexpected);
1109     data_grade_item_update($data);
1111     return true;
1115 /**
1116  * deletes an instance of a data
1117  *
1118  * @global object
1119  * @param int $id
1120  * @return bool
1121  */
1122 function data_delete_instance($id) {    // takes the dataid
1123     global $DB, $CFG;
1125     if (!$data = $DB->get_record('data', array('id'=>$id))) {
1126         return false;
1127     }
1129     $cm = get_coursemodule_from_instance('data', $data->id);
1130     $context = context_module::instance($cm->id);
1132 /// Delete all the associated information
1134     // files
1135     $fs = get_file_storage();
1136     $fs->delete_area_files($context->id, 'mod_data');
1138     // get all the records in this data
1139     $sql = "SELECT r.id
1140               FROM {data_records} r
1141              WHERE r.dataid = ?";
1143     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
1145     // delete all the records and fields
1146     $DB->delete_records('data_records', array('dataid'=>$id));
1147     $DB->delete_records('data_fields', array('dataid'=>$id));
1149     // Remove old calendar events.
1150     $events = $DB->get_records('event', array('modulename' => 'data', 'instance' => $id));
1151     foreach ($events as $event) {
1152         $event = calendar_event::load($event);
1153         $event->delete();
1154     }
1156     // cleanup gradebook
1157     data_grade_item_delete($data);
1159     // Delete the instance itself
1160     // We must delete the module record after we delete the grade item.
1161     $result = $DB->delete_records('data', array('id'=>$id));
1163     return $result;
1166 /**
1167  * returns a summary of data activity of this user
1168  *
1169  * @global object
1170  * @param object $course
1171  * @param object $user
1172  * @param object $mod
1173  * @param object $data
1174  * @return object|null
1175  */
1176 function data_user_outline($course, $user, $mod, $data) {
1177     global $DB, $CFG;
1178     require_once("$CFG->libdir/gradelib.php");
1180     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1181     if (empty($grades->items[0]->grades)) {
1182         $grade = false;
1183     } else {
1184         $grade = reset($grades->items[0]->grades);
1185     }
1188     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
1189         $result = new stdClass();
1190         $result->info = get_string('numrecords', 'data', $countrecords);
1191         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
1192                                               WHERE dataid = ? AND userid = ?
1193                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
1194         $result->time = $lastrecord->timemodified;
1195         if ($grade) {
1196             if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1197                 $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1198             } else {
1199                 $result->info = get_string('grade') . ': ' . get_string('hidden', 'grades');
1200             }
1201         }
1202         return $result;
1203     } else if ($grade) {
1204         $result = new stdClass();
1205         if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1206             $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1207         } else {
1208             $result->info = get_string('grade') . ': ' . get_string('hidden', 'grades');
1209         }
1211         //datesubmitted == time created. dategraded == time modified or time overridden
1212         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1213         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1214         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1215             $result->time = $grade->dategraded;
1216         } else {
1217             $result->time = $grade->datesubmitted;
1218         }
1220         return $result;
1221     }
1222     return NULL;
1225 /**
1226  * Prints all the records uploaded by this user
1227  *
1228  * @global object
1229  * @param object $course
1230  * @param object $user
1231  * @param object $mod
1232  * @param object $data
1233  */
1234 function data_user_complete($course, $user, $mod, $data) {
1235     global $DB, $CFG, $OUTPUT;
1236     require_once("$CFG->libdir/gradelib.php");
1238     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1239     if (!empty($grades->items[0]->grades)) {
1240         $grade = reset($grades->items[0]->grades);
1241         if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1242             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1243             if ($grade->str_feedback) {
1244                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1245             }
1246         } else {
1247             echo $OUTPUT->container(get_string('grade') . ': ' . get_string('hidden', 'grades'));
1248         }
1249     }
1251     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1252         data_print_template('singletemplate', $records, $data);
1253     }
1256 /**
1257  * Return grade for given user or all users.
1258  *
1259  * @global object
1260  * @param object $data
1261  * @param int $userid optional user id, 0 means all users
1262  * @return array array of grades, false if none
1263  */
1264 function data_get_user_grades($data, $userid=0) {
1265     global $CFG;
1267     require_once($CFG->dirroot.'/rating/lib.php');
1269     $ratingoptions = new stdClass;
1270     $ratingoptions->component = 'mod_data';
1271     $ratingoptions->ratingarea = 'entry';
1272     $ratingoptions->modulename = 'data';
1273     $ratingoptions->moduleid   = $data->id;
1275     $ratingoptions->userid = $userid;
1276     $ratingoptions->aggregationmethod = $data->assessed;
1277     $ratingoptions->scaleid = $data->scale;
1278     $ratingoptions->itemtable = 'data_records';
1279     $ratingoptions->itemtableusercolumn = 'userid';
1281     $rm = new rating_manager();
1282     return $rm->get_user_grades($ratingoptions);
1285 /**
1286  * Update activity grades
1287  *
1288  * @category grade
1289  * @param object $data
1290  * @param int $userid specific user only, 0 means all
1291  * @param bool $nullifnone
1292  */
1293 function data_update_grades($data, $userid=0, $nullifnone=true) {
1294     global $CFG, $DB;
1295     require_once($CFG->libdir.'/gradelib.php');
1297     if (!$data->assessed) {
1298         data_grade_item_update($data);
1300     } else if ($grades = data_get_user_grades($data, $userid)) {
1301         data_grade_item_update($data, $grades);
1303     } else if ($userid and $nullifnone) {
1304         $grade = new stdClass();
1305         $grade->userid   = $userid;
1306         $grade->rawgrade = NULL;
1307         data_grade_item_update($data, $grade);
1309     } else {
1310         data_grade_item_update($data);
1311     }
1314 /**
1315  * Update/create grade item for given data
1316  *
1317  * @category grade
1318  * @param stdClass $data A database instance with extra cmidnumber property
1319  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1320  * @return object grade_item
1321  */
1322 function data_grade_item_update($data, $grades=NULL) {
1323     global $CFG;
1324     require_once($CFG->libdir.'/gradelib.php');
1326     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1328     if (!$data->assessed or $data->scale == 0) {
1329         $params['gradetype'] = GRADE_TYPE_NONE;
1331     } else if ($data->scale > 0) {
1332         $params['gradetype'] = GRADE_TYPE_VALUE;
1333         $params['grademax']  = $data->scale;
1334         $params['grademin']  = 0;
1336     } else if ($data->scale < 0) {
1337         $params['gradetype'] = GRADE_TYPE_SCALE;
1338         $params['scaleid']   = -$data->scale;
1339     }
1341     if ($grades  === 'reset') {
1342         $params['reset'] = true;
1343         $grades = NULL;
1344     }
1346     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1349 /**
1350  * Delete grade item for given data
1351  *
1352  * @category grade
1353  * @param object $data object
1354  * @return object grade_item
1355  */
1356 function data_grade_item_delete($data) {
1357     global $CFG;
1358     require_once($CFG->libdir.'/gradelib.php');
1360     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1363 // junk functions
1364 /**
1365  * takes a list of records, the current data, a search string,
1366  * and mode to display prints the translated template
1367  *
1368  * @global object
1369  * @global object
1370  * @param string $template
1371  * @param array $records
1372  * @param object $data
1373  * @param string $search
1374  * @param int $page
1375  * @param bool $return
1376  * @param object $jumpurl a moodle_url by which to jump back to the record list (can be null)
1377  * @return mixed
1378  */
1379 function data_print_template($template, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null) {
1380     global $CFG, $DB, $OUTPUT;
1382     $cm = get_coursemodule_from_instance('data', $data->id);
1383     $context = context_module::instance($cm->id);
1385     static $fields = array();
1386     static $dataid = null;
1388     if (empty($dataid)) {
1389         $dataid = $data->id;
1390     } else if ($dataid != $data->id) {
1391         $fields = array();
1392     }
1394     if (empty($fields)) {
1395         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1396         foreach ($fieldrecords as $fieldrecord) {
1397             $fields[]= data_get_field($fieldrecord, $data);
1398         }
1399     }
1401     if (empty($records)) {
1402         return;
1403     }
1405     if (!$jumpurl) {
1406         $jumpurl = new moodle_url('/mod/data/view.php', array('d' => $data->id));
1407     }
1408     $jumpurl = new moodle_url($jumpurl, array('page' => $page, 'sesskey' => sesskey()));
1410     foreach ($records as $record) {   // Might be just one for the single template
1412     // Replacing tags
1413         $patterns = array();
1414         $replacement = array();
1416     // Then we generate strings to replace for normal tags
1417         foreach ($fields as $field) {
1418             $patterns[]='[['.$field->field->name.']]';
1419             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1420         }
1422         $canmanageentries = has_capability('mod/data:manageentries', $context);
1424     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1425         $patterns[]='##edit##';
1426         $patterns[]='##delete##';
1427         if (data_user_can_manage_entry($record, $data, $context)) {
1428             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1429                              .$data->id.'&amp;rid='.$record->id.'&amp;sesskey='.sesskey().'">' .
1430                              $OUTPUT->pix_icon('t/edit', get_string('edit')) . '</a>';
1431             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1432                              .$data->id.'&amp;delete='.$record->id.'&amp;sesskey='.sesskey().'">' .
1433                              $OUTPUT->pix_icon('t/delete', get_string('delete')) . '</a>';
1434         } else {
1435             $replacement[] = '';
1436             $replacement[] = '';
1437         }
1439         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1440         if ($search) {
1441             $moreurl .= '&amp;filter=1';
1442         }
1443         $patterns[]='##more##';
1444         $replacement[] = '<a href="'.$moreurl.'">' . $OUTPUT->pix_icon('t/preview', get_string('more', 'data')) . '</a>';
1446         $patterns[]='##moreurl##';
1447         $replacement[] = $moreurl;
1449         $patterns[]='##delcheck##';
1450         if ($canmanageentries) {
1451             $replacement[] = html_writer::checkbox('delcheck[]', $record->id, false, '', array('class' => 'recordcheckbox'));
1452         } else {
1453             $replacement[] = '';
1454         }
1456         $patterns[]='##user##';
1457         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1458                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1460         $patterns[] = '##userpicture##';
1461         $ruser = user_picture::unalias($record, null, 'userid');
1462         // If the record didn't come with user data, retrieve the user from database.
1463         if (!isset($ruser->picture)) {
1464             $ruser = core_user::get_user($record->userid);
1465         }
1466         $replacement[] = $OUTPUT->user_picture($ruser, array('courseid' => $data->course));
1468         $patterns[]='##export##';
1470         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1471             && ((has_capability('mod/data:exportentry', $context)
1472                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1473             require_once($CFG->libdir . '/portfoliolib.php');
1474             $button = new portfolio_add_button();
1475             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), 'mod_data');
1476             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1477             $button->set_formats($formats);
1478             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1479         } else {
1480             $replacement[] = '';
1481         }
1483         $patterns[] = '##timeadded##';
1484         $replacement[] = userdate($record->timecreated);
1486         $patterns[] = '##timemodified##';
1487         $replacement [] = userdate($record->timemodified);
1489         $patterns[]='##approve##';
1490         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)) {
1491             $approveurl = new moodle_url($jumpurl, array('approve' => $record->id));
1492             $approveicon = new pix_icon('t/approve', get_string('approve', 'data'), '', array('class' => 'iconsmall'));
1493             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($approveurl, $approveicon),
1494                     array('class' => 'approve'));
1495         } else {
1496             $replacement[] = '';
1497         }
1499         $patterns[]='##disapprove##';
1500         if (has_capability('mod/data:approve', $context) && ($data->approval) && ($record->approved)) {
1501             $disapproveurl = new moodle_url($jumpurl, array('disapprove' => $record->id));
1502             $disapproveicon = new pix_icon('t/block', get_string('disapprove', 'data'), '', array('class' => 'iconsmall'));
1503             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($disapproveurl, $disapproveicon),
1504                     array('class' => 'disapprove'));
1505         } else {
1506             $replacement[] = '';
1507         }
1509         $patterns[] = '##approvalstatus##';
1510         if (!$data->approval) {
1511             $replacement[] = '';
1512         } else if ($record->approved) {
1513             $replacement[] = get_string('approved', 'data');
1514         } else {
1515             $replacement[] = get_string('notapproved', 'data');
1516         }
1518         $patterns[]='##comments##';
1519         if (($template == 'listtemplate') && ($data->comments)) {
1521             if (!empty($CFG->usecomments)) {
1522                 require_once($CFG->dirroot  . '/comment/lib.php');
1523                 list($context, $course, $cm) = get_context_info_array($context->id);
1524                 $cmt = new stdClass();
1525                 $cmt->context = $context;
1526                 $cmt->course  = $course;
1527                 $cmt->cm      = $cm;
1528                 $cmt->area    = 'database_entry';
1529                 $cmt->itemid  = $record->id;
1530                 $cmt->showcount = true;
1531                 $cmt->component = 'mod_data';
1532                 $comment = new comment($cmt);
1533                 $replacement[] = $comment->output(true);
1534             }
1535         } else {
1536             $replacement[] = '';
1537         }
1539         if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1540             $patterns[] = "##tags##";
1541             $replacement[] = $OUTPUT->tag_list(
1542                 core_tag_tag::get_item_tags('mod_data', 'data_records', $record->id), '', 'data-tags');
1543         }
1545         // actual replacement of the tags
1546         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1548         // no more html formatting and filtering - see MDL-6635
1549         if ($return) {
1550             return $newtext;
1551         } else {
1552             echo $newtext;
1554             // hack alert - return is always false in singletemplate anyway ;-)
1555             /**********************************
1556              *    Printing Ratings Form       *
1557              *********************************/
1558             if ($template == 'singletemplate') {    //prints ratings options
1559                 data_print_ratings($data, $record);
1560             }
1562             /**********************************
1563              *    Printing Comments Form       *
1564              *********************************/
1565             if (($template == 'singletemplate') && ($data->comments)) {
1566                 if (!empty($CFG->usecomments)) {
1567                     require_once($CFG->dirroot . '/comment/lib.php');
1568                     list($context, $course, $cm) = get_context_info_array($context->id);
1569                     $cmt = new stdClass();
1570                     $cmt->context = $context;
1571                     $cmt->course  = $course;
1572                     $cmt->cm      = $cm;
1573                     $cmt->area    = 'database_entry';
1574                     $cmt->itemid  = $record->id;
1575                     $cmt->showcount = true;
1576                     $cmt->component = 'mod_data';
1577                     $comment = new comment($cmt);
1578                     $comment->output(false);
1579                 }
1580             }
1581         }
1582     }
1585 /**
1586  * Return rating related permissions
1587  *
1588  * @param string $contextid the context id
1589  * @param string $component the component to get rating permissions for
1590  * @param string $ratingarea the rating area to get permissions for
1591  * @return array an associative array of the user's rating permissions
1592  */
1593 function data_rating_permissions($contextid, $component, $ratingarea) {
1594     $context = context::instance_by_id($contextid, MUST_EXIST);
1595     if ($component != 'mod_data' || $ratingarea != 'entry') {
1596         return null;
1597     }
1598     return array(
1599         'view'    => has_capability('mod/data:viewrating',$context),
1600         'viewany' => has_capability('mod/data:viewanyrating',$context),
1601         'viewall' => has_capability('mod/data:viewallratings',$context),
1602         'rate'    => has_capability('mod/data:rate',$context)
1603     );
1606 /**
1607  * Validates a submitted rating
1608  * @param array $params submitted data
1609  *            context => object the context in which the rated items exists [required]
1610  *            itemid => int the ID of the object being rated
1611  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1612  *            rating => int the submitted rating
1613  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1614  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1615  * @return boolean true if the rating is valid. Will throw rating_exception if not
1616  */
1617 function data_rating_validate($params) {
1618     global $DB, $USER;
1620     // Check the component is mod_data
1621     if ($params['component'] != 'mod_data') {
1622         throw new rating_exception('invalidcomponent');
1623     }
1625     // Check the ratingarea is entry (the only rating area in data module)
1626     if ($params['ratingarea'] != 'entry') {
1627         throw new rating_exception('invalidratingarea');
1628     }
1630     // Check the rateduserid is not the current user .. you can't rate your own entries
1631     if ($params['rateduserid'] == $USER->id) {
1632         throw new rating_exception('nopermissiontorate');
1633     }
1635     $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
1636                   FROM {data_records} r
1637                   JOIN {data} d ON r.dataid = d.id
1638                  WHERE r.id = :itemid";
1639     $dataparams = array('itemid'=>$params['itemid']);
1640     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1641         //item doesn't exist
1642         throw new rating_exception('invaliditemid');
1643     }
1645     if ($info->scale != $params['scaleid']) {
1646         //the scale being submitted doesnt match the one in the database
1647         throw new rating_exception('invalidscaleid');
1648     }
1650     //check that the submitted rating is valid for the scale
1652     // lower limit
1653     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1654         throw new rating_exception('invalidnum');
1655     }
1657     // upper limit
1658     if ($info->scale < 0) {
1659         //its a custom scale
1660         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1661         if ($scalerecord) {
1662             $scalearray = explode(',', $scalerecord->scale);
1663             if ($params['rating'] > count($scalearray)) {
1664                 throw new rating_exception('invalidnum');
1665             }
1666         } else {
1667             throw new rating_exception('invalidscaleid');
1668         }
1669     } else if ($params['rating'] > $info->scale) {
1670         //if its numeric and submitted rating is above maximum
1671         throw new rating_exception('invalidnum');
1672     }
1674     if ($info->approval && !$info->approved) {
1675         //database requires approval but this item isnt approved
1676         throw new rating_exception('nopermissiontorate');
1677     }
1679     // check the item we're rating was created in the assessable time window
1680     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1681         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1682             throw new rating_exception('notavailable');
1683         }
1684     }
1686     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1687     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1688     $context = context_module::instance($cm->id);
1690     // if the supplied context doesnt match the item's context
1691     if ($context->id != $params['context']->id) {
1692         throw new rating_exception('invalidcontext');
1693     }
1695     // Make sure groups allow this user to see the item they're rating
1696     $groupid = $info->groupid;
1697     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1698         if (!groups_group_exists($groupid)) { // Can't find group
1699             throw new rating_exception('cannotfindgroup');//something is wrong
1700         }
1702         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1703             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1704             throw new rating_exception('notmemberofgroup');
1705         }
1706     }
1708     return true;
1711 /**
1712  * Can the current user see ratings for a given itemid?
1713  *
1714  * @param array $params submitted data
1715  *            contextid => int contextid [required]
1716  *            component => The component for this module - should always be mod_data [required]
1717  *            ratingarea => object the context in which the rated items exists [required]
1718  *            itemid => int the ID of the object being rated [required]
1719  *            scaleid => int scale id [optional]
1720  * @return bool
1721  * @throws coding_exception
1722  * @throws rating_exception
1723  */
1724 function mod_data_rating_can_see_item_ratings($params) {
1725     global $DB;
1727     // Check the component is mod_data.
1728     if (!isset($params['component']) || $params['component'] != 'mod_data') {
1729         throw new rating_exception('invalidcomponent');
1730     }
1732     // Check the ratingarea is entry (the only rating area in data).
1733     if (!isset($params['ratingarea']) || $params['ratingarea'] != 'entry') {
1734         throw new rating_exception('invalidratingarea');
1735     }
1737     if (!isset($params['itemid'])) {
1738         throw new rating_exception('invaliditemid');
1739     }
1741     $datasql = "SELECT d.id as dataid, d.course, r.groupid
1742                   FROM {data_records} r
1743                   JOIN {data} d ON r.dataid = d.id
1744                  WHERE r.id = :itemid";
1745     $dataparams = array('itemid' => $params['itemid']);
1746     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1747         // Item doesn't exist.
1748         throw new rating_exception('invaliditemid');
1749     }
1751     // User can see ratings of all participants.
1752     if ($info->groupid == 0) {
1753         return true;
1754     }
1756     $course = $DB->get_record('course', array('id' => $info->course), '*', MUST_EXIST);
1757     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1759     // Make sure groups allow this user to see the item they're rating.
1760     return groups_group_visible($info->groupid, $course, $cm);
1764 /**
1765  * function that takes in the current data, number of items per page,
1766  * a search string and prints a preference box in view.php
1767  *
1768  * This preference box prints a searchable advanced search template if
1769  *     a) A template is defined
1770  *  b) The advanced search checkbox is checked.
1771  *
1772  * @global object
1773  * @global object
1774  * @param object $data
1775  * @param int $perpage
1776  * @param string $search
1777  * @param string $sort
1778  * @param string $order
1779  * @param array $search_array
1780  * @param int $advanced
1781  * @param string $mode
1782  * @return void
1783  */
1784 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1785     global $CFG, $DB, $PAGE, $OUTPUT;
1787     $cm = get_coursemodule_from_instance('data', $data->id);
1788     $context = context_module::instance($cm->id);
1789     echo '<br /><div class="datapreferences">';
1790     echo '<form id="options" action="view.php" method="get">';
1791     echo '<div>';
1792     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1793     if ($mode =='asearch') {
1794         $advanced = 1;
1795         echo '<input type="hidden" name="mode" value="list" />';
1796     }
1797     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1798     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1799                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1800     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id' => 'pref_perpage', 'class' => 'custom-select'));
1802     if ($advanced) {
1803         $regsearchclass = 'search_none';
1804         $advancedsearchclass = 'search_inline';
1805     } else {
1806         $regsearchclass = 'search_inline';
1807         $advancedsearchclass = 'search_none';
1808     }
1809     echo '<div id="reg_search" class="' . $regsearchclass . ' form-inline" >&nbsp;&nbsp;&nbsp;';
1810     echo '<label for="pref_search">' . get_string('search') . '</label> <input type="text" ' .
1811          'class="form-control" size="16" name="search" id= "pref_search" value="' . s($search) . '" /></div>';
1812     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1813     // foreach field, print the option
1814     echo '<select name="sort" id="pref_sortby" class="custom-select mr-1">';
1815     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1816         echo '<optgroup label="'.get_string('fields', 'data').'">';
1817         foreach ($fields as $field) {
1818             if ($field->id == $sort) {
1819                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1820             } else {
1821                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1822             }
1823         }
1824         echo '</optgroup>';
1825     }
1826     $options = array();
1827     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1828     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1829     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1830     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1831     if ($data->approval and has_capability('mod/data:approve', $context)) {
1832         $options[DATA_APPROVED] = get_string('approved', 'data');
1833     }
1834     echo '<optgroup label="'.get_string('other', 'data').'">';
1835     foreach ($options as $key => $name) {
1836         if ($key == $sort) {
1837             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1838         } else {
1839             echo '<option value="'.$key.'">'.$name.'</option>';
1840         }
1841     }
1842     echo '</optgroup>';
1843     echo '</select>';
1844     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1845     echo '<select id="pref_order" name="order" class="custom-select mr-1">';
1846     if ($order == 'ASC') {
1847         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1848     } else {
1849         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1850     }
1851     if ($order == 'DESC') {
1852         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1853     } else {
1854         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1855     }
1856     echo '</select>';
1858     if ($advanced) {
1859         $checked = ' checked="checked" ';
1860     }
1861     else {
1862         $checked = '';
1863     }
1864     $PAGE->requires->js('/mod/data/data.js');
1865     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1866     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1867     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" ' . $checked . ' ' .
1868          'onchange="showHideAdvSearch(this.checked);" class="mx-1" />' .
1869          '<label for="advancedcheckbox">' . get_string('advancedsearch', 'data') . '</label>';
1870     echo '&nbsp;<input type="submit" class="btn btn-secondary" value="' . get_string('savesettings', 'data') . '" />';
1872     echo '<br />';
1873     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1874     echo '<table class="boxaligncenter">';
1876     // print ASC or DESC
1877     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1878     $i = 0;
1880     // Determine if we are printing all fields for advanced search, or the template for advanced search
1881     // If a template is not defined, use the deafault template and display all fields.
1882     if(empty($data->asearchtemplate)) {
1883         data_generate_default_template($data, 'asearchtemplate');
1884     }
1886     static $fields = array();
1887     static $dataid = null;
1889     if (empty($dataid)) {
1890         $dataid = $data->id;
1891     } else if ($dataid != $data->id) {
1892         $fields = array();
1893     }
1895     if (empty($fields)) {
1896         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1897         foreach ($fieldrecords as $fieldrecord) {
1898             $fields[]= data_get_field($fieldrecord, $data);
1899         }
1900     }
1902     // Replacing tags
1903     $patterns = array();
1904     $replacement = array();
1906     // Then we generate strings to replace for normal tags
1907     foreach ($fields as $field) {
1908         $fieldname = $field->field->name;
1909         $fieldname = preg_quote($fieldname, '/');
1910         $patterns[] = "/\[\[$fieldname\]\]/i";
1911         $searchfield = data_get_field_from_id($field->field->id, $data);
1912         if (!empty($search_array[$field->field->id]->data)) {
1913             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1914         } else {
1915             $replacement[] = $searchfield->display_search_field();
1916         }
1917     }
1918     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1919     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1920     $patterns[]    = '/##firstname##/';
1921     $replacement[] = '<label class="accesshide" for="u_fn">' . get_string('authorfirstname', 'data') . '</label>' .
1922                      '<input type="text" class="form-control" size="16" id="u_fn" name="u_fn" value="' . s($fn) . '" />';
1923     $patterns[]    = '/##lastname##/';
1924     $replacement[] = '<label class="accesshide" for="u_ln">' . get_string('authorlastname', 'data') . '</label>' .
1925                      '<input type="text" class="form-control" size="16" id="u_ln" name="u_ln" value="' . s($ln) . '" />';
1927     if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1928         $patterns[] = "/##tags##/";
1929         $selectedtags = isset($search_array[DATA_TAGS]->rawtagnames) ? $search_array[DATA_TAGS]->rawtagnames : [];
1930         $replacement[] = data_generate_tag_form(false, $selectedtags);
1931     }
1933     // actual replacement of the tags
1935     $options = new stdClass();
1936     $options->para=false;
1937     $options->noclean=true;
1938     echo '<tr><td>';
1939     echo preg_replace($patterns, $replacement, format_text($data->asearchtemplate, FORMAT_HTML, $options));
1940     echo '</td></tr>';
1942     echo '<tr><td colspan="4"><br/>' .
1943          '<input type="submit" class="btn btn-primary mr-1" value="' . get_string('savesettings', 'data') . '" />' .
1944          '<input type="submit" class="btn btn-secondary" name="resetadv" value="' . get_string('resetsettings', 'data') . '" />' .
1945          '</td></tr>';
1946     echo '</table>';
1947     echo '</div>';
1948     echo '</div>';
1949     echo '</form>';
1950     echo '</div>';
1953 /**
1954  * @global object
1955  * @global object
1956  * @param object $data
1957  * @param object $record
1958  * @return void Output echo'd
1959  */
1960 function data_print_ratings($data, $record) {
1961     global $OUTPUT;
1962     if (!empty($record->rating)){
1963         echo $OUTPUT->render($record->rating);
1964     }
1967 /**
1968  * List the actions that correspond to a view of this module.
1969  * This is used by the participation report.
1970  *
1971  * Note: This is not used by new logging system. Event with
1972  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1973  *       be considered as view action.
1974  *
1975  * @return array
1976  */
1977 function data_get_view_actions() {
1978     return array('view');
1981 /**
1982  * List the actions that correspond to a post of this module.
1983  * This is used by the participation report.
1984  *
1985  * Note: This is not used by new logging system. Event with
1986  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1987  *       will be considered as post action.
1988  *
1989  * @return array
1990  */
1991 function data_get_post_actions() {
1992     return array('add','update','record delete');
1995 /**
1996  * @param string $name
1997  * @param int $dataid
1998  * @param int $fieldid
1999  * @return bool
2000  */
2001 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
2002     global $DB;
2004     if (!is_numeric($name)) {
2005         $like = $DB->sql_like('df.name', ':name', false);
2006     } else {
2007         $like = "df.name = :name";
2008     }
2009     $params = array('name'=>$name);
2010     if ($fieldid) {
2011         $params['dataid']   = $dataid;
2012         $params['fieldid1'] = $fieldid;
2013         $params['fieldid2'] = $fieldid;
2014         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2015                                         WHERE $like AND df.dataid = :dataid
2016                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
2017     } else {
2018         $params['dataid']   = $dataid;
2019         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2020                                         WHERE $like AND df.dataid = :dataid", $params);
2021     }
2024 /**
2025  * @param array $fieldinput
2026  */
2027 function data_convert_arrays_to_strings(&$fieldinput) {
2028     foreach ($fieldinput as $key => $val) {
2029         if (is_array($val)) {
2030             $str = '';
2031             foreach ($val as $inner) {
2032                 $str .= $inner . ',';
2033             }
2034             $str = substr($str, 0, -1);
2036             $fieldinput->$key = $str;
2037         }
2038     }
2042 /**
2043  * Converts a database (module instance) to use the Roles System
2044  *
2045  * @global object
2046  * @global object
2047  * @uses CONTEXT_MODULE
2048  * @uses CAP_PREVENT
2049  * @uses CAP_ALLOW
2050  * @param object $data a data object with the same attributes as a record
2051  *                     from the data database table
2052  * @param int $datamodid the id of the data module, from the modules table
2053  * @param array $teacherroles array of roles that have archetype teacher
2054  * @param array $studentroles array of roles that have archetype student
2055  * @param array $guestroles array of roles that have archetype guest
2056  * @param int $cmid the course_module id for this data instance
2057  * @return boolean data module was converted or not
2058  */
2059 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
2060     global $CFG, $DB, $OUTPUT;
2062     if (!isset($data->participants) && !isset($data->assesspublic)
2063             && !isset($data->groupmode)) {
2064         // We assume that this database has already been converted to use the
2065         // Roles System. above fields get dropped the data module has been
2066         // upgraded to use Roles.
2067         return false;
2068     }
2070     if (empty($cmid)) {
2071         // We were not given the course_module id. Try to find it.
2072         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
2073             echo $OUTPUT->notification('Could not get the course module for the data');
2074             return false;
2075         } else {
2076             $cmid = $cm->id;
2077         }
2078     }
2079     $context = context_module::instance($cmid);
2082     // $data->participants:
2083     // 1 - Only teachers can add entries
2084     // 3 - Teachers and students can add entries
2085     switch ($data->participants) {
2086         case 1:
2087             foreach ($studentroles as $studentrole) {
2088                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
2089             }
2090             foreach ($teacherroles as $teacherrole) {
2091                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2092             }
2093             break;
2094         case 3:
2095             foreach ($studentroles as $studentrole) {
2096                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
2097             }
2098             foreach ($teacherroles as $teacherrole) {
2099                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2100             }
2101             break;
2102     }
2104     // $data->assessed:
2105     // 2 - Only teachers can rate posts
2106     // 1 - Everyone can rate posts
2107     // 0 - No one can rate posts
2108     switch ($data->assessed) {
2109         case 0:
2110             foreach ($studentroles as $studentrole) {
2111                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2112             }
2113             foreach ($teacherroles as $teacherrole) {
2114                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
2115             }
2116             break;
2117         case 1:
2118             foreach ($studentroles as $studentrole) {
2119                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
2120             }
2121             foreach ($teacherroles as $teacherrole) {
2122                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2123             }
2124             break;
2125         case 2:
2126             foreach ($studentroles as $studentrole) {
2127                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2128             }
2129             foreach ($teacherroles as $teacherrole) {
2130                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2131             }
2132             break;
2133     }
2135     // $data->assesspublic:
2136     // 0 - Students can only see their own ratings
2137     // 1 - Students can see everyone's ratings
2138     switch ($data->assesspublic) {
2139         case 0:
2140             foreach ($studentroles as $studentrole) {
2141                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
2142             }
2143             foreach ($teacherroles as $teacherrole) {
2144                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2145             }
2146             break;
2147         case 1:
2148             foreach ($studentroles as $studentrole) {
2149                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
2150             }
2151             foreach ($teacherroles as $teacherrole) {
2152                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2153             }
2154             break;
2155     }
2157     if (empty($cm)) {
2158         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
2159     }
2161     switch ($cm->groupmode) {
2162         case NOGROUPS:
2163             break;
2164         case SEPARATEGROUPS:
2165             foreach ($studentroles as $studentrole) {
2166                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
2167             }
2168             foreach ($teacherroles as $teacherrole) {
2169                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2170             }
2171             break;
2172         case VISIBLEGROUPS:
2173             foreach ($studentroles as $studentrole) {
2174                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
2175             }
2176             foreach ($teacherroles as $teacherrole) {
2177                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2178             }
2179             break;
2180     }
2181     return true;
2184 /**
2185  * Returns the best name to show for a preset
2186  *
2187  * @param string $shortname
2188  * @param  string $path
2189  * @return string
2190  */
2191 function data_preset_name($shortname, $path) {
2193     // We are looking inside the preset itself as a first choice, but also in normal data directory
2194     $string = get_string('modulename', 'datapreset_'.$shortname);
2196     if (substr($string, 0, 1) == '[') {
2197         return $shortname;
2198     } else {
2199         return $string;
2200     }
2203 /**
2204  * Returns an array of all the available presets.
2205  *
2206  * @return array
2207  */
2208 function data_get_available_presets($context) {
2209     global $CFG, $USER;
2211     $presets = array();
2213     // First load the ratings sub plugins that exist within the modules preset dir
2214     if ($dirs = core_component::get_plugin_list('datapreset')) {
2215         foreach ($dirs as $dir=>$fulldir) {
2216             if (is_directory_a_preset($fulldir)) {
2217                 $preset = new stdClass();
2218                 $preset->path = $fulldir;
2219                 $preset->userid = 0;
2220                 $preset->shortname = $dir;
2221                 $preset->name = data_preset_name($dir, $fulldir);
2222                 if (file_exists($fulldir.'/screenshot.jpg')) {
2223                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
2224                 } else if (file_exists($fulldir.'/screenshot.png')) {
2225                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
2226                 } else if (file_exists($fulldir.'/screenshot.gif')) {
2227                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
2228                 }
2229                 $presets[] = $preset;
2230             }
2231         }
2232     }
2233     // Now add to that the site presets that people have saved
2234     $presets = data_get_available_site_presets($context, $presets);
2235     return $presets;
2238 /**
2239  * Gets an array of all of the presets that users have saved to the site.
2240  *
2241  * @param stdClass $context The context that we are looking from.
2242  * @param array $presets
2243  * @return array An array of presets
2244  */
2245 function data_get_available_site_presets($context, array $presets=array()) {
2246     global $USER;
2248     $fs = get_file_storage();
2249     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2250     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
2251     if (empty($files)) {
2252         return $presets;
2253     }
2254     foreach ($files as $file) {
2255         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
2256             continue;
2257         }
2258         $preset = new stdClass;
2259         $preset->path = $file->get_filepath();
2260         $preset->name = trim($preset->path, '/');
2261         $preset->shortname = $preset->name;
2262         $preset->userid = $file->get_userid();
2263         $preset->id = $file->get_id();
2264         $preset->storedfile = $file;
2265         $presets[] = $preset;
2266     }
2267     return $presets;
2270 /**
2271  * Deletes a saved preset.
2272  *
2273  * @param string $name
2274  * @return bool
2275  */
2276 function data_delete_site_preset($name) {
2277     $fs = get_file_storage();
2279     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
2280     if (!empty($files)) {
2281         foreach ($files as $file) {
2282             $file->delete();
2283         }
2284     }
2286     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
2287     if (!empty($dir)) {
2288         $dir->delete();
2289     }
2290     return true;
2293 /**
2294  * Prints the heads for a page
2295  *
2296  * @param stdClass $course
2297  * @param stdClass $cm
2298  * @param stdClass $data
2299  * @param string $currenttab
2300  */
2301 function data_print_header($course, $cm, $data, $currenttab='') {
2303     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
2305     $PAGE->set_title($data->name);
2306     echo $OUTPUT->header();
2307     echo $OUTPUT->heading(format_string($data->name), 2);
2308     echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro');
2310     // Groups needed for Add entry tab
2311     $currentgroup = groups_get_activity_group($cm);
2312     $groupmode = groups_get_activity_groupmode($cm);
2314     // Print the tabs
2316     if ($currenttab) {
2317         include('tabs.php');
2318     }
2320     // Print any notices
2322     if (!empty($displaynoticegood)) {
2323         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
2324     } else if (!empty($displaynoticebad)) {
2325         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
2326     }
2329 /**
2330  * Can user add more entries?
2331  *
2332  * @param object $data
2333  * @param mixed $currentgroup
2334  * @param int $groupmode
2335  * @param stdClass $context
2336  * @return bool
2337  */
2338 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2339     global $USER;
2341     if (empty($context)) {
2342         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2343         $context = context_module::instance($cm->id);
2344     }
2346     if (has_capability('mod/data:manageentries', $context)) {
2347         // no entry limits apply if user can manage
2349     } else if (!has_capability('mod/data:writeentry', $context)) {
2350         return false;
2352     } else if (data_atmaxentries($data)) {
2353         return false;
2354     } else if (data_in_readonly_period($data)) {
2355         // Check whether we're in a read-only period
2356         return false;
2357     }
2359     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2360         return true;
2361     }
2363     if ($currentgroup) {
2364         return groups_is_member($currentgroup);
2365     } else {
2366         //else it might be group 0 in visible mode
2367         if ($groupmode == VISIBLEGROUPS){
2368             return true;
2369         } else {
2370             return false;
2371         }
2372     }
2375 /**
2376  * Check whether the current user is allowed to manage the given record considering manageentries capability,
2377  * data_in_readonly_period() result, ownership (determined by data_isowner()) and manageapproved setting.
2378  * @param mixed $record record object or id
2379  * @param object $data data object
2380  * @param object $context context object
2381  * @return bool returns true if the user is allowd to edit the entry, false otherwise
2382  */
2383 function data_user_can_manage_entry($record, $data, $context) {
2384     global $DB;
2386     if (has_capability('mod/data:manageentries', $context)) {
2387         return true;
2388     }
2390     // Check whether this activity is read-only at present.
2391     $readonly = data_in_readonly_period($data);
2393     if (!$readonly) {
2394         // Get record object from db if just id given like in data_isowner.
2395         // ...done before calling data_isowner() to avoid querying db twice.
2396         if (!is_object($record)) {
2397             if (!$record = $DB->get_record('data_records', array('id' => $record))) {
2398                 return false;
2399             }
2400         }
2401         if (data_isowner($record)) {
2402             if ($data->approval && $record->approved) {
2403                 return $data->manageapproved == 1;
2404             } else {
2405                 return true;
2406             }
2407         }
2408     }
2410     return false;
2413 /**
2414  * Check whether the specified database activity is currently in a read-only period
2415  *
2416  * @param object $data
2417  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2418  */
2419 function data_in_readonly_period($data) {
2420     $now = time();
2421     if (!$data->timeviewfrom && !$data->timeviewto) {
2422         return false;
2423     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2424         return false;
2425     }
2426     return true;
2429 /**
2430  * @return bool
2431  */
2432 function is_directory_a_preset($directory) {
2433     $directory = rtrim($directory, '/\\') . '/';
2434     $status = file_exists($directory.'singletemplate.html') &&
2435               file_exists($directory.'listtemplate.html') &&
2436               file_exists($directory.'listtemplateheader.html') &&
2437               file_exists($directory.'listtemplatefooter.html') &&
2438               file_exists($directory.'addtemplate.html') &&
2439               file_exists($directory.'rsstemplate.html') &&
2440               file_exists($directory.'rsstitletemplate.html') &&
2441               file_exists($directory.'csstemplate.css') &&
2442               file_exists($directory.'jstemplate.js') &&
2443               file_exists($directory.'preset.xml');
2445     return $status;
2448 /**
2449  * Abstract class used for data preset importers
2450  */
2451 abstract class data_preset_importer {
2453     protected $course;
2454     protected $cm;
2455     protected $module;
2456     protected $directory;
2458     /**
2459      * Constructor
2460      *
2461      * @param stdClass $course
2462      * @param stdClass $cm
2463      * @param stdClass $module
2464      * @param string $directory
2465      */
2466     public function __construct($course, $cm, $module, $directory) {
2467         $this->course = $course;
2468         $this->cm = $cm;
2469         $this->module = $module;
2470         $this->directory = $directory;
2471     }
2473     /**
2474      * Returns the name of the directory the preset is located in
2475      * @return string
2476      */
2477     public function get_directory() {
2478         return basename($this->directory);
2479     }
2481     /**
2482      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2483      * @param file_storage $filestorage. should be null if using a conventional directory
2484      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2485      * @param string $dir the directory to look in. null if using the Moodle file storage
2486      * @param string $filename the name of the file we want
2487      * @return string the contents of the file or null if the file doesn't exist.
2488      */
2489     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2490         if(empty($filestorage) || empty($fileobj)) {
2491             if (substr($dir, -1)!='/') {
2492                 $dir .= '/';
2493             }
2494             if (file_exists($dir.$filename)) {
2495                 return file_get_contents($dir.$filename);
2496             } else {
2497                 return null;
2498             }
2499         } else {
2500             if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
2501                 $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2502                 return $file->get_content();
2503             } else {
2504                 return null;
2505             }
2506         }
2508     }
2509     /**
2510      * Gets the preset settings
2511      * @global moodle_database $DB
2512      * @return stdClass
2513      */
2514     public function get_preset_settings() {
2515         global $DB;
2517         $fs = $fileobj = null;
2518         if (!is_directory_a_preset($this->directory)) {
2519             //maybe the user requested a preset stored in the Moodle file storage
2521             $fs = get_file_storage();
2522             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2524             //preset name to find will be the final element of the directory
2525             $explodeddirectory = explode('/', $this->directory);
2526             $presettofind = end($explodeddirectory);
2528             //now go through the available files available and see if we can find it
2529             foreach ($files as $file) {
2530                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2531                     continue;
2532                 }
2533                 $presetname = trim($file->get_filepath(), '/');
2534                 if ($presetname==$presettofind) {
2535                     $this->directory = $presetname;
2536                     $fileobj = $file;
2537                 }
2538             }
2540             if (empty($fileobj)) {
2541                 print_error('invalidpreset', 'data', '', $this->directory);
2542             }
2543         }
2545         $allowed_settings = array(
2546             'intro',
2547             'comments',
2548             'requiredentries',
2549             'requiredentriestoview',
2550             'maxentries',
2551             'rssarticles',
2552             'approval',
2553             'defaultsortdir',
2554             'defaultsort');
2556         $result = new stdClass;
2557         $result->settings = new stdClass;
2558         $result->importfields = array();
2559         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2560         if (!$result->currentfields) {
2561             $result->currentfields = array();
2562         }
2565         /* Grab XML */
2566         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2567         $parsedxml = xmlize($presetxml, 0);
2569         /* First, do settings. Put in user friendly array. */
2570         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2571         $result->settings = new StdClass();
2572         foreach ($settingsarray as $setting => $value) {
2573             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2574                 // unsupported setting
2575                 continue;
2576             }
2577             $result->settings->$setting = $value[0]['#'];
2578         }
2580         /* Now work out fields to user friendly array */
2581         $fieldsarray = $parsedxml['preset']['#']['field'];
2582         foreach ($fieldsarray as $field) {
2583             if (!is_array($field)) {
2584                 continue;
2585             }
2586             $f = new StdClass();
2587             foreach ($field['#'] as $param => $value) {
2588                 if (!is_array($value)) {
2589                     continue;
2590                 }
2591                 $f->$param = $value[0]['#'];
2592             }
2593             $f->dataid = $this->module->id;
2594             $f->type = clean_param($f->type, PARAM_ALPHA);
2595             $result->importfields[] = $f;
2596         }
2597         /* Now add the HTML templates to the settings array so we can update d */
2598         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2599         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2600         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2601         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2602         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2603         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2604         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2605         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2606         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2607         $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2609         $result->settings->instance = $this->module->id;
2610         return $result;
2611     }
2613     /**
2614      * Import the preset into the given database module
2615      * @return bool
2616      */
2617     function import($overwritesettings) {
2618         global $DB, $CFG;
2620         $params = $this->get_preset_settings();
2621         $settings = $params->settings;
2622         $newfields = $params->importfields;
2623         $currentfields = $params->currentfields;
2624         $preservedfields = array();
2626         /* Maps fields and makes new ones */
2627         if (!empty($newfields)) {
2628             /* We require an injective mapping, and need to know what to protect */
2629             foreach ($newfields as $nid => $newfield) {
2630                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2631                 if ($cid == -1) {
2632                     continue;
2633                 }
2634                 if (array_key_exists($cid, $preservedfields)){
2635                     print_error('notinjectivemap', 'data');
2636                 }
2637                 else $preservedfields[$cid] = true;
2638             }
2640             foreach ($newfields as $nid => $newfield) {
2641                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2643                 /* A mapping. Just need to change field params. Data kept. */
2644                 if ($cid != -1 and isset($currentfields[$cid])) {
2645                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2646                     foreach ($newfield as $param => $value) {
2647                         if ($param != "id") {
2648                             $fieldobject->field->$param = $value;
2649                         }
2650                     }
2651                     unset($fieldobject->field->similarfield);
2652                     $fieldobject->update_field();
2653                     unset($fieldobject);
2654                 } else {
2655                     /* Make a new field */
2656                     include_once("field/$newfield->type/field.class.php");
2658                     if (!isset($newfield->description)) {
2659                         $newfield->description = '';
2660                     }
2661                     $classname = 'data_field_'.$newfield->type;
2662                     $fieldclass = new $classname($newfield, $this->module);
2663                     $fieldclass->insert_field();
2664                     unset($fieldclass);
2665                 }
2666             }
2667         }
2669         /* Get rid of all old unused data */
2670         if (!empty($preservedfields)) {
2671             foreach ($currentfields as $cid => $currentfield) {
2672                 if (!array_key_exists($cid, $preservedfields)) {
2673                     /* Data not used anymore so wipe! */
2674                     print "Deleting field $currentfield->name<br />";
2676                     $id = $currentfield->id;
2677                     //Why delete existing data records and related comments/ratings??
2678                     $DB->delete_records('data_content', array('fieldid'=>$id));
2679                     $DB->delete_records('data_fields', array('id'=>$id));
2680                 }
2681             }
2682         }
2684         // handle special settings here
2685         if (!empty($settings->defaultsort)) {
2686             if (is_numeric($settings->defaultsort)) {
2687                 // old broken value
2688                 $settings->defaultsort = 0;
2689             } else {
2690                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2691             }
2692         } else {
2693             $settings->defaultsort = 0;
2694         }
2696         // do we want to overwrite all current database settings?
2697         if ($overwritesettings) {
2698             // all supported settings
2699             $overwrite = array_keys((array)$settings);
2700         } else {
2701             // only templates and sorting
2702             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2703                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2704                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2705         }
2707         // now overwrite current data settings
2708         foreach ($this->module as $prop=>$unused) {
2709             if (in_array($prop, $overwrite)) {
2710                 $this->module->$prop = $settings->$prop;
2711             }
2712         }
2714         data_update_instance($this->module);
2716         return $this->cleanup();
2717     }
2719     /**
2720      * Any clean up routines should go here
2721      * @return bool
2722      */
2723     public function cleanup() {
2724         return true;
2725     }
2728 /**
2729  * Data preset importer for uploaded presets
2730  */
2731 class data_preset_upload_importer extends data_preset_importer {
2732     public function __construct($course, $cm, $module, $filepath) {
2733         global $USER;
2734         if (is_file($filepath)) {
2735             $fp = get_file_packer();
2736             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2737                 fulldelete($filepath);
2738             }
2739             $filepath .= '_extracted';
2740         }
2741         parent::__construct($course, $cm, $module, $filepath);
2742     }
2743     public function cleanup() {
2744         return fulldelete($this->directory);
2745     }
2748 /**
2749  * Data preset importer for existing presets
2750  */
2751 class data_preset_existing_importer extends data_preset_importer {
2752     protected $userid;
2753     public function __construct($course, $cm, $module, $fullname) {
2754         global $USER;
2755         list($userid, $shortname) = explode('/', $fullname, 2);
2756         $context = context_module::instance($cm->id);
2757         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2758            throw new coding_exception('Invalid preset provided');
2759         }
2761         $this->userid = $userid;
2762         $filepath = data_preset_path($course, $userid, $shortname);
2763         parent::__construct($course, $cm, $module, $filepath);
2764     }
2765     public function get_userid() {
2766         return $this->userid;
2767     }
2770 /**
2771  * @global object
2772  * @global object
2773  * @param object $course
2774  * @param int $userid
2775  * @param string $shortname
2776  * @return string
2777  */
2778 function data_preset_path($course, $userid, $shortname) {
2779     global $USER, $CFG;
2781     $context = context_course::instance($course->id);
2783     $userid = (int)$userid;
2785     $path = null;
2786     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2787         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2788     } else if ($userid == 0) {
2789         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2790     } else if ($userid < 0) {
2791         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2792     }
2794     return $path;
2797 /**
2798  * Implementation of the function for printing the form elements that control
2799  * whether the course reset functionality affects the data.
2800  *
2801  * @param $mform form passed by reference
2802  */
2803 function data_reset_course_form_definition(&$mform) {
2804     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2805     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2807     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2808     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2810     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2811     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2813     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2814     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2816     $mform->addElement('checkbox', 'reset_data_tags', get_string('removealldatatags', 'data'));
2817     $mform->disabledIf('reset_data_tags', 'reset_data', 'checked');
2820 /**
2821  * Course reset form defaults.
2822  * @return array
2823  */
2824 function data_reset_course_form_defaults($course) {
2825     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2828 /**
2829  * Removes all grades from gradebook
2830  *
2831  * @global object
2832  * @global object
2833  * @param int $courseid
2834  * @param string $type optional type
2835  */
2836 function data_reset_gradebook($courseid, $type='') {
2837     global $CFG, $DB;
2839     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2840               FROM {data} d, {course_modules} cm, {modules} m
2841              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2843     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2844         foreach ($datas as $data) {
2845             data_grade_item_update($data, 'reset');
2846         }
2847     }
2850 /**
2851  * Actual implementation of the reset course functionality, delete all the
2852  * data responses for course $data->courseid.
2853  *
2854  * @global object
2855  * @global object
2856  * @param object $data the data submitted from the reset course.
2857  * @return array status array
2858  */
2859 function data_reset_userdata($data) {
2860     global $CFG, $DB;
2861     require_once($CFG->libdir.'/filelib.php');
2862     require_once($CFG->dirroot.'/rating/lib.php');
2864     $componentstr = get_string('modulenameplural', 'data');
2865     $status = array();
2867     $allrecordssql = "SELECT r.id
2868                         FROM {data_records} r
2869                              INNER JOIN {data} d ON r.dataid = d.id
2870                        WHERE d.course = ?";
2872     $alldatassql = "SELECT d.id
2873                       FROM {data} d
2874                      WHERE d.course=?";
2876     $rm = new rating_manager();
2877     $ratingdeloptions = new stdClass;
2878     $ratingdeloptions->component = 'mod_data';
2879     $ratingdeloptions->ratingarea = 'entry';
2881     // Set the file storage - may need it to remove files later.
2882     $fs = get_file_storage();
2884     // delete entries if requested
2885     if (!empty($data->reset_data)) {
2886         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2887         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2888         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2890         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2891             foreach ($datas as $dataid=>$unused) {
2892                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2893                     continue;
2894                 }
2895                 $datacontext = context_module::instance($cm->id);
2897                 // Delete any files that may exist.
2898                 $fs->delete_area_files($datacontext->id, 'mod_data', 'content');
2900                 $ratingdeloptions->contextid = $datacontext->id;
2901                 $rm->delete_ratings($ratingdeloptions);
2903                 core_tag_tag::delete_instances('mod_data', null, $datacontext->id);
2904             }
2905         }
2907         if (empty($data->reset_gradebook_grades)) {
2908             // remove all grades from gradebook
2909             data_reset_gradebook($data->courseid);
2910         }
2911         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2912     }
2914     // remove entries by users not enrolled into course
2915     if (!empty($data->reset_data_notenrolled)) {
2916         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2917                          FROM {data_records} r
2918                               JOIN {data} d ON r.dataid = d.id
2919                               LEFT JOIN {user} u ON r.userid = u.id
2920                         WHERE d.course = ? AND r.userid > 0";
2922         $course_context = context_course::instance($data->courseid);
2923         $notenrolled = array();
2924         $fields = array();
2925         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2926         foreach ($rs as $record) {
2927             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2928               or !is_enrolled($course_context, $record->userid)) {
2929                 //delete ratings
2930                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2931                     continue;
2932                 }
2933                 $datacontext = context_module::instance($cm->id);
2934                 $ratingdeloptions->contextid = $datacontext->id;
2935                 $ratingdeloptions->itemid = $record->id;
2936                 $rm->delete_ratings($ratingdeloptions);
2938                 // Delete any files that may exist.
2939                 if ($contents = $DB->get_records('data_content', array('recordid' => $record->id), '', 'id')) {
2940                     foreach ($contents as $content) {
2941                         $fs->delete_area_files($datacontext->id, 'mod_data', 'content', $content->id);
2942                     }
2943                 }
2944                 $notenrolled[$record->userid] = true;
2946                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $record->id);
2948                 $DB->delete_records('comments', array('itemid' => $record->id, 'commentarea' => 'database_entry'));
2949                 $DB->delete_records('data_content', array('recordid' => $record->id));
2950                 $DB->delete_records('data_records', array('id' => $record->id));
2951             }
2952         }
2953         $rs->close();
2954         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2955     }
2957     // remove all ratings
2958     if (!empty($data->reset_data_ratings)) {
2959         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2960             foreach ($datas as $dataid=>$unused) {
2961                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2962                     continue;
2963                 }
2964                 $datacontext = context_module::instance($cm->id);
2966                 $ratingdeloptions->contextid = $datacontext->id;
2967                 $rm->delete_ratings($ratingdeloptions);
2968             }
2969         }
2971         if (empty($data->reset_gradebook_grades)) {
2972             // remove all grades from gradebook
2973             data_reset_gradebook($data->courseid);
2974         }
2976         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2977     }
2979     // remove all comments
2980     if (!empty($data->reset_data_comments)) {
2981         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2982         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2983     }
2985     // Remove all the tags.
2986     if (!empty($data->reset_data_tags)) {
2987         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2988             foreach ($datas as $dataid => $unused) {
2989                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2990                     continue;
2991                 }
2993                 $context = context_module::instance($cm->id);
2994                 core_tag_tag::delete_instances('mod_data', null, $context->id);
2996             }
2997         }
2998         $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'data'), 'error' => false);
2999     }
3001     // updating dates - shift may be negative too
3002     if ($data->timeshift) {
3003         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
3004         // See MDL-9367.
3005         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto',
3006             'timeviewfrom', 'timeviewto', 'assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
3007         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3008     }
3010     return $status;
3013 /**
3014  * Returns all other caps used in module
3015  *
3016  * @return array
3017  */
3018 function data_get_extra_capabilities() {
3019     return ['moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate',
3020             'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete'];
3023 /**
3024  * @param string $feature FEATURE_xx constant for requested feature
3025  * @return mixed True if module supports feature, null if doesn't know
3026  */
3027 function data_supports($feature) {
3028     switch($feature) {
3029         case FEATURE_GROUPS:                  return true;
3030         case FEATURE_GROUPINGS:               return true;
3031         case FEATURE_MOD_INTRO:               return true;
3032         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
3033         case FEATURE_COMPLETION_HAS_RULES:    return true;
3034         case FEATURE_GRADE_HAS_GRADE:         return true;
3035         case FEATURE_GRADE_OUTCOMES:          return true;
3036         case FEATURE_RATE:                    return true;
3037         case FEATURE_BACKUP_MOODLE2:          return true;
3038         case FEATURE_SHOW_DESCRIPTION:        return true;
3039         case FEATURE_COMMENT:                 return true;
3041         default: return null;
3042     }
3044 /**
3045  * @global object
3046  * @param array $export
3047  * @param string $delimiter_name
3048  * @param object $database
3049  * @param int $count
3050  * @param bool $return
3051  * @return string|void
3052  */
3053 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
3054     global $CFG;
3055     require_once($CFG->libdir . '/csvlib.class.php');
3057     $filename = $database . '-' . $count . '-record';
3058     if ($count > 1) {
3059         $filename .= 's';
3060     }
3061     if ($return) {
3062         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
3063     } else {
3064         csv_export_writer::download_array($filename, $export, $delimiter_name);
3065     }
3068 /**
3069  * @global object
3070  * @param array $export
3071  * @param string $dataname
3072  * @param int $count
3073  * @return string
3074  */
3075 function data_export_xls($export, $dataname, $count) {
3076     global $CFG;
3077     require_once("$CFG->libdir/excellib.class.php");
3078     $filename = clean_filename("{$dataname}-{$count}_record");
3079     if ($count > 1) {
3080         $filename .= 's';
3081     }
3082     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3083     $filename .= '.xls';
3085     $filearg = '-';
3086     $workbook = new MoodleExcelWorkbook($filearg);
3087     $workbook->send($filename);
3088     $worksheet = array();
3089     $worksheet[0] = $workbook->add_worksheet('');
3090     $rowno = 0;
3091     foreach ($export as $row) {
3092         $colno = 0;
3093         foreach($row as $col) {
3094             $worksheet[0]->write($rowno, $colno, $col);
3095             $colno++;
3096         }
3097         $rowno++;
3098     }
3099     $workbook->close();
3100     return $filename;
3103 /**
3104  * @global object
3105  * @param array $export
3106  * @param string $dataname
3107  * @param int $count
3108  * @param string
3109  */
3110 function data_export_ods($export, $dataname, $count) {
3111     global $CFG;
3112     require_once("$CFG->libdir/odslib.class.php");
3113     $filename = clean_filename("{$dataname}-{$count}_record");
3114     if ($count > 1) {
3115         $filename .= 's';
3116     }
3117     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3118     $filename .= '.ods';
3119     $filearg = '-';
3120     $workbook = new MoodleODSWorkbook($filearg);
3121     $workbook->send($filename);
3122     $worksheet = array();
3123     $worksheet[0] = $workbook->add_worksheet('');
3124     $rowno = 0;
3125     foreach ($export as $row) {
3126         $colno = 0;
3127         foreach($row as $col) {
3128             $worksheet[0]->write($rowno, $colno, $col);
3129             $colno++;
3130         }
3131         $rowno++;
3132     }
3133     $workbook->close();
3134     return $filename;
3137 /**
3138  * @global object
3139  * @param int $dataid
3140  * @param array $fields
3141  * @param array $selectedfields
3142  * @param int $currentgroup group ID of the current group. This is used for
3143  * exporting data while maintaining group divisions.
3144  * @param object $context the context in which the operation is performed (for capability checks)
3145  * @param bool $userdetails whether to include the details of the record author
3146  * @param bool $time whether to include time created/modified
3147  * @param bool $approval whether to include approval status
3148  * @param bool $tags whether to include tags
3149  * @return array
3150  */
3151 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
3152                              $userdetails=false, $time=false, $approval=false, $tags = false) {
3153     global $DB;
3155     if (is_null($context)) {
3156         $context = context_system::instance();
3157     }
3158     // exporting user data needs special permission
3159     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
3161     $exportdata = array();
3163     // populate the header in first row of export
3164     foreach($fields as $key => $field) {
3165         if (!in_array($field->field->id, $selectedfields)) {
3166             // ignore values we aren't exporting
3167             unset($fields[$key]);
3168         } else {
3169             $exportdata[0][] = $field->field->name;
3170         }
3171     }
3172     if ($tags) {
3173         $exportdata[0][] = get_string('tags', 'data');
3174     }
3175     if ($userdetails) {
3176         $exportdata[0][] = get_string('user');
3177         $exportdata[0][] = get_string('username');
3178         $exportdata[0][] = get_string('email');
3179     }
3180     if ($time) {
3181         $exportdata[0][] = get_string('timeadded', 'data');
3182         $exportdata[0][] = get_string('timemodified', 'data');
3183     }
3184     if ($approval) {
3185         $exportdata[0][] = get_string('approved', 'data');
3186     }
3188     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
3189     ksort($datarecords);
3190     $line = 1;
3191     foreach($datarecords as $record) {
3192         // get content indexed by fieldid
3193         if ($currentgroup) {
3194             $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 = ?';
3195             $where = array($record->id, $currentgroup);
3196         } else {
3197             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
3198             $where = array($record->id);
3199         }
3201         if( $content = $DB->get_records_sql($select, $where) ) {
3202             foreach($fields as $field) {
3203                 $contents = '';
3204                 if(isset($content[$field->field->id])) {
3205                     $contents = $field->export_text_value($content[$field->field->id]);
3206                 }
3207                 $exportdata[$line][] = $contents;
3208             }
3209             if ($tags) {
3210                 $itemtags = \core_tag_tag::get_item_tags_array('mod_data', 'data_records', $record->id);
3211                 $exportdata[$line][] = implode(', ', $itemtags);
3212             }
3213             if ($userdetails) { // Add user details to the export data
3214                 $userdata = get_complete_user_data('id', $record->userid);
3215                 $exportdata[$line][] = fullname($userdata);
3216                 $exportdata[$line][] = $userdata->username;
3217                 $exportdata[$line][] = $userdata->email;
3218             }
3219             if ($time) { // Add time added / modified
3220                 $exportdata[$line][] = userdate($record->timecreated);
3221                 $exportdata[$line][] = userdate($record->timemodified);
3222             }
3223             if ($approval) { // Add approval status
3224                 $exportdata[$line][] = (int) $record->approved;
3225             }
3226         }
3227         $line++;
3228     }
3229     $line--;
3230     return $exportdata;
3233 ////////////////////////////////////////////////////////////////////////////////
3234 // File API                                                                   //
3235 ////////////////////////////////////////////////////////////////////////////////
3237 /**
3238  * Lists all browsable file areas
3239  *
3240  * @package  mod_data
3241  * @category files
3242  * @param stdClass $course course object
3243  * @param stdClass $cm course module object
3244  * @param stdClass $context context object
3245  * @return array
3246  */
3247 function data_get_file_areas($course, $cm, $context) {
3248     return array('content' => get_string('areacontent', 'mod_data'));
3251 /**
3252  * File browsing support for data module.
3253  *
3254  * @param file_browser $browser
3255  * @param array $areas
3256  * @param stdClass $course
3257  * @param cm_info $cm
3258  * @param context $context
3259  * @param string $filearea
3260  * @param int $itemid
3261  * @param string $filepath
3262  * @param string $filename
3263  * @return file_info_stored file_info_stored instance or null if not found
3264  */
3265 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
3266     global $CFG, $DB, $USER;
3268     if ($context->contextlevel != CONTEXT_MODULE) {
3269         return null;
3270     }
3272     if (!isset($areas[$filearea])) {
3273         return null;
3274     }
3276     if (is_null($itemid)) {
3277         require_once($CFG->dirroot.'/mod/data/locallib.php');
3278         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
3279     }
3281     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
3282         return null;
3283     }
3285     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3286         return null;
3287     }
3289     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3290         return null;
3291     }
3293     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3294         return null;
3295     }
3297     //check if approved
3298     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3299         return null;
3300     }
3302     // group access
3303     if ($record->groupid) {
3304         $groupmode = groups_get_activity_groupmode($cm, $course);
3305         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3306             if (!groups_is_member($record->groupid)) {
3307                 return null;
3308             }
3309         }
3310     }
3312     $fieldobj = data_get_field($field, $data, $cm);
3314     $filepath = is_null($filepath) ? '/' : $filepath;
3315     $filename = is_null($filename) ? '.' : $filename;
3316     if (!$fieldobj->file_ok($filepath.$filename)) {
3317         return null;
3318     }
3320     $fs = get_file_storage();
3321     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
3322         return null;
3323     }
3325     // Checks to see if the user can manage files or is the owner.
3326     // TODO MDL-33805 - Do not use userid here and move the capability check above.
3327     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
3328         return null;
3329     }
3331     $urlbase = $CFG->wwwroot.'/pluginfile.php';
3333     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
3336 /**
3337  * Serves the data attachments. Implements needed access control ;-)
3338  *
3339  * @package  mod_data
3340  * @category files
3341  * @param stdClass $course course object
3342  * @param stdClass $cm course module object
3343  * @param stdClass $context context object
3344  * @param string $filearea file area
3345  * @param array $args extra arguments
3346  * @param bool $forcedownload whether or not force download
3347  * @param array $options additional options affecting the file serving
3348  * @return bool false if file not found, does not return if found - justsend the file
3349  */
3350 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
3351     global $CFG, $DB;
3353     if ($context->contextlevel != CONTEXT_MODULE) {
3354         return false;
3355     }
3357     require_course_login($course, true, $cm);
3359     if ($filearea === 'content') {
3360         $contentid = (int)array_shift($args);
3362         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
3363             return false;
3364         }
3366         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3367             return false;
3368         }
3370         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3371             return false;
3372         }
3374         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3375             return false;
3376         }
3378         if ($data->id != $cm->instance) {
3379             // hacker attempt - context does not match the contentid
3380             return false;
3381         }
3383         //check if approved
3384         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3385             return false;
3386         }
3388         // group access
3389         if ($record->groupid) {
3390             $groupmode = groups_get_activity_groupmode($cm, $course);
3391             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3392                 if (!groups_is_member($record->groupid)) {
3393                     return false;
3394                 }
3395             }
3396         }
3398         $fieldobj = data_get_field($field, $data, $cm);
3400         $relativepath = implode('/', $args);
3401         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
3403         if (!$fieldobj->file_ok($relativepath)) {
3404             return false;
3405         }
3407         $fs = get_file_storage();
3408         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3409             return false;
3410         }
3412         // finally send the file
3413         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
3414     }
3416     return false;
3420 function data_extend_navigation($navigation, $course, $module, $cm) {
3421     global $CFG, $OUTPUT, $USER, $DB;
3422     require_once($CFG->dirroot . '/mod/data/locallib.php');
3424     $rid = optional_param('rid', 0, PARAM_INT);
3426     $data = $DB->get_record('data', array('id'=>$cm->instance));
3427     $currentgroup = groups_get_activity_group($cm);
3428     $groupmode = groups_get_activity_groupmode($cm);
3430      $numentries = data_numentries($data);
3431     $canmanageentries = has_capability('mod/data:manageentries', context_module::instance($cm->id));
3433     if ($data->entriesleft = data_get_entries_left_to_add($data, $numentries, $canmanageentries)) {
3434         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3435         $entriesnode->add_class('note');
3436     }
3438     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3439     if (!empty($rid)) {
3440         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3441     } else {
3442         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3443     }
3444     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3447 /**
3448  * Adds module specific settings to the settings block
3449  *
3450  * @param settings_navigation $settings The settings navigation object
3451  * @param navigation_node $datanode The node to add module settings to
3452  */
3453 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3454     global $PAGE, $DB, $CFG, $USER;
3456     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3458     $currentgroup = groups_get_activity_group($PAGE->cm);
3459     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3461     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3462         if (empty($editentry)) { //TODO: undefined
3463             $addstring = get_string('add', 'data');
3464         } else {
3465             $addstring = get_string('editentry', 'data');
3466         }
3467         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3468     }
3470     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3471         // The capability required to Export database records is centrally defined in 'lib.php'
3472         // and should be weaker than those required to edit Templates, Fields and Presets.
3473         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3474     }
3475     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3476         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3477     }
3479     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3480         $currenttab = '';
3481         if ($currenttab == 'list') {
3482             $defaultemplate = 'listtemplate';
3483         } else if ($currenttab == 'add') {
3484             $defaultemplate = 'addtemplate';
3485         } else if ($currenttab == 'asearch') {
3486             $defaultemplate = 'asearchtemplate';
3487         } else {
3488             $defaultemplate = 'singletemplate';
3489         }
3491         $templates = $datanode->add(get_string('templates', 'data'));
3493         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3494         foreach ($templatelist as $template) {
3495             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3496         }
3498         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3499         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3500     }
3502     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3503         require_once("$CFG->libdir/rsslib.php");
3505         $string = get_string('rsstype','forum');
3507         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3508         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3509     }
3512 /**
3513  * Save the database configuration as a preset.
3514  *
3515  * @param stdClass $course The course the database module belongs to.
3516  * @param stdClass $cm The course module record
3517  * @param stdClass $data The database record
3518  * @param string $path
3519  * @return bool
3520  */
3521 function data_presets_save($course, $cm, $data, $path) {
3522     global $USER;
3523     $fs = get_file_storage();
3524     $filerecord = new stdClass;
3525     $filerecord->contextid = DATA_PRESET_CONTEXT;
3526     $filerecord->component = DATA_PRESET_COMPONENT;
3527     $filerecord->filearea = DATA_PRESET_FILEAREA;
3528     $filerecord->itemid = 0;
3529     $filerecord->filepath = '/'.$path.'/';
3530     $filerecord->userid = $USER->id;
3532     $filerecord->filename = 'preset.xml';
3533     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3535     $filerecord->filename = 'singletemplate.html';
3536     $fs->create_file_from_string($filerecord, $data->singletemplate);
3538     $filerecord->filename = 'listtemplateheader.html';
3539     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3541     $filerecord->filename = 'listtemplate.html';
3542     $fs->create_file_from_string($filerecord, $data->listtemplate);
3544     $filerecord->filename = 'listtemplatefooter.html';
3545     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3547     $filerecord->filename = 'addtemplate.html';
3548     $fs->create_file_from_string($filerecord, $data->addtemplate);
3550     $filerecord->filename = 'rsstemplate.html';
3551     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3553     $filerecord->filename = 'rsstitletemplate.html';
3554     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3556     $filerecord->filename = 'csstemplate.css';
3557     $fs->create_file_from_string($filerecord, $data->csstemplate);
3559     $filerecord->filename = 'jstemplate.js';
3560     $fs->create_file_from_string($filerecord, $data->jstemplate);
3562     $filerecord->filename = 'asearchtemplate.html';
3563     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3565     return true;
3568 /**
3569  * Generates the XML for the database module provided
3570  *
3571  * @global moodle_database $DB
3572  * @param stdClass $course The course the database module belongs to.
3573  * @param stdClass $cm The course module record
3574  * @param stdClass $data The database record
3575  * @return string The XML for the preset
3576  */
3577 function data_presets_generate_xml($course, $cm, $data) {
3578     global $DB;
3580     // Assemble "preset.xml":
3581     $presetxmldata = "<preset>\n\n";
3583     // Raw settings are not preprocessed during saving of presets
3584     $raw_settings = array(
3585         'intro',
3586         'comments',
3587         'requiredentries',
3588         'requiredentriestoview',
3589         'maxentries',
3590         'rssarticles',
3591         'approval',
3592         'manageapproved',
3593         'defaultsortdir'
3594     );
3596     $presetxmldata .= "<settings>\n";
3597     // First, settings that do not require any conversion
3598     foreach ($raw_settings as $setting) {
3599         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3600     }
3602     // Now specific settings
3603     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3604         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3605     } else {
3606         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3607     }
3608     $presetxmldata .= "</settings>\n\n";
3609     // Now for the fields. Grab all that are non-empty
3610     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3611     ksort($fields);
3612     if (!empty($fields)) {
3613         foreach ($fields as $field) {
3614             $presetxmldata .= "<field>\n";
3615             foreach ($field as $key => $value) {
3616                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3617                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3618                 }
3619             }
3620             $presetxmldata .= "</field>\n\n";
3621         }
3622     }
3623     $presetxmldata .= '</preset>';
3624     return $presetxmldata;
3627 function data_presets_export($course, $cm, $data, $tostorage=false) {
3628     global $CFG, $DB;
3630     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3631     $exportsubdir = "mod_data/presetexport/$presetname";
3632     make_temp_directory($exportsubdir);
3633     $exportdir = "$CFG->tempdir/$exportsubdir";
3635     // Assemble "preset.xml":
3636     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3638     // After opening a file in write mode, close it asap
3639     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3640     fwrite($presetxmlfile, $presetxmldata);
3641     fclose($presetxmlfile);
3643     // Now write the template files
3644     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3645     fwrite($singletemplate, $data->singletemplate);
3646     fclose($singletemplate);
3648     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3649     fwrite($listtemplateheader, $data->listtemplateheader);
3650     fclose($listtemplateheader);
3652     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3653     fwrite($listtemplate, $data->listtemplate);
3654     fclose($listtemplate);
3656     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3657     fwrite($listtemplatefooter, $data->listtemplatefooter);
3658     fclose($listtemplatefooter);
3660     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3661     fwrite($addtemplate, $data->addtemplate);
3662     fclose($addtemplate);
3664     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3665     fwrite($rsstemplate, $data->rsstemplate);
3666     fclose($rsstemplate);
3668     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3669     fwrite($rsstitletemplate, $data->rsstitletemplate);
3670     fclose($rsstitletemplate);
3672     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3673     fwrite($csstemplate, $data->csstemplate);
3674     fclose($csstemplate);
3676     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3677     fwrite($jstemplate, $data->jstemplate);
3678     fclose($jstemplate);
3680     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3681     fwrite($asearchtemplate, $data->asearchtemplate);
3682     fclose($asearchtemplate);
3684     // Check if all files have been generated
3685     if (! is_directory_a_preset($exportdir)) {
3686         print_error('generateerror', 'data');
3687     }
3689     $filenames = array(
3690         'preset.xml',
3691         'singletemplate.html',
3692         'listtemplateheader.html',
3693         'listtemplate.html',
3694         'listtemplatefooter.html',
3695         'addtemplate.html',
3696         'rsstemplate.html',
3697         'rsstitletemplate.html',
3698         'csstemplate.css',
3699         'jstemplate.js',
3700         'asearchtemplate.html'
3701     );
3703     $filelist = array();
3704     foreach ($filenames as $filename) {
3705         $filelist[$filename] = $exportdir . '/' . $filename;
3706     }
3708     $exportfile = $exportdir.'.zip';
3709     file_exists($exportfile) && unlink($exportfile);
3711     $fp = get_file_packer('application/zip');
3712     $fp->archive_to_pathname($filelist, $exportfile);
3714     foreach ($filelist as $file) {
3715         unlink($file);
3716     }
3717     rmdir($exportdir);
3719     // Return the full path to the exported preset file:
3720     return $exportfile;
3723 /**
3724  * Running addtional permission check on plugin, for example, plugins
3725  * may have switch to turn on/off comments option, this callback will
3726  * affect UI display, not like pluginname_comment_validate only throw
3727  * exceptions.
3728  * Capability check has been done in comment->check_permissions(), we
3729  * don't need to do it again here.
3730  *
3731  * @package  mod_data
3732  * @category comment
3733  *
3734  * @param stdClass $comment_param {
3735  *              context  => context the context object
3736  *              courseid => int course id
3737  *              cm       => stdClass course module object
3738  *              commentarea => string comment area
3739  *              itemid      => int itemid
3740  * }
3741  * @return array
3742  */
3743 function data_comment_permissions($comment_param) {
3744     global $CFG, $DB;
3745     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3746         throw new comment_exception('invalidcommentitemid');
3747     }
3748     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3749         throw new comment_exception('invalidid', 'data');
3750     }
3751     if ($data->comments) {
3752         return array('post'=>true, 'view'=>true);
3753     } else {
3754         return array('post'=>false, 'view'=>false);
3755     }
3758 /**
3759  * Validate comment parameter before perform other comments actions
3760  *
3761  * @package  mod_data
3762  * @category comment
3763  *
3764  * @param stdClass $comment_param {
3765  *              context  => context the context object
3766  *              courseid => int course id
3767  *              cm       => stdClass course module object
3768  *              commentarea => string comment area
3769  *              itemid      => int itemid
3770  * }
3771  * @return boolean
3772  */
3773 function data_comment_validate($comment_param) {
3774     global $DB;
3775     // validate comment area
3776     if ($comment_param->commentarea != 'database_entry') {
3777         throw new comment_exception('invalidcommentarea');
3778     }
3779     // validate itemid
3780     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3781         throw new comment_exception('invalidcommentitemid');
3782     }
3783     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3784         throw new comment_exception('invalidid', 'data');
3785     }
3786     if (!$course = $DB->get_record('course', array('id'=>$data->course))) {
3787         throw new comment_exception('coursemisconf');
3788     }
3789     if (!$cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
3790         throw new comment_exception('invalidcoursemodule');
3791     }
3792     if (!$data->comments) {
3793         throw new comment_exception('commentsoff', 'data');
3794     }
3795     $context = context_module::instance($cm->id);
3797     //check if approved
3798     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3799         throw new comment_exception('notapproved', 'data');
3800     }
3802     // group access
3803     if ($record->groupid) {
3804         $groupmode = groups_get_activity_groupmode($cm, $course);
3805         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3806             if (!groups_is_member($record->groupid)) {
3807                 throw new comment_exception('notmemberofgroup');
3808             }
3809         }
3810     }
3811     // validate context id
3812     if ($context->id != $comment_param->context->id) {
3813         throw new comment_exception('invalidcontext');
3814     }
3815     // validation for comment deletion
3816     if (!empty($comment_param->commentid)) {
3817         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3818             if ($comment->commentarea != 'database_entry') {
3819                 throw new comment_exception('invalidcommentarea');
3820             }
3821             if ($comment->contextid != $comment_param->context->id) {
3822                 throw new comment_exception('invalidcontext');
3823             }
3824             if ($comment->itemid != $comment_param->itemid) {
3825                 throw new comment_exception('invalidcommentitemid');
3826             }
3827         } else {
3828             throw new comment_exception('invalidcommentid');
3829         }
3830     }
3831     return true;
3834 /**
3835  * Return a list of page types
3836  * @param string $pagetype current page type
3837  * @param stdClass $parentcontext Block's parent context
3838  * @param stdClass $currentcontext Current context of block
3839  */
3840 function data_page_type_list($pagetype, $parentcontext, $currentcontext) {
3841     $module_pagetype = array('mod-data-*'=>get_string('page-mod-data-x', 'data'));
3842     return $module_pagetype;
3845 /**
3846  * Get all of the record ids from a database activity.
3847  *
3848  * @param int    $dataid      The dataid of the database module.
3849  * @param object $selectdata  Contains an additional sql statement for the
3850  *                            where clause for group and approval fields.
3851  * @param array  $params      Parameters that coincide with the sql statement.
3852  * @return array $idarray     An array of record ids
3853  */
3854 function data_get_all_recordids($dataid, $selectdata = '', $params = null) {
3855     global $DB;
3856     $initsql = 'SELECT r.id
3857                   FROM {data_records} r
3858                  WHERE r.dataid = :dataid';
3859     if ($selectdata != '') {
3860         $initsql .= $selectdata;
3861         $params = array_merge(array('dataid' => $dataid), $params);
3862     } else {
3863         $params = array('dataid' => $dataid);
3864     }
3865     $initsql .= ' GROUP BY r.id';
3866     $initrecord = $DB->get_recordset_sql($initsql, $params);
3867     $idarray = array();
3868     foreach ($initrecord as $data) {
3869         $idarray[] = $data->id;
3870     }
3871     // Close the record set and free up resources.
3872     $initrecord->close();
3873     return $idarray;
3876 /**
3877  * Get the ids of all the records that match that advanced search criteria
3878  * This goes and loops through each criterion one at a time until it either
3879  * runs out of records or returns a subset of records.
3880  *
3881  * @param array $recordids    An array of record ids.
3882  * @param array $searcharray  Contains information for the advanced search criteria
3883  * @param int $dataid         The data id of the database.
3884  * @return array $recordids   An array of record ids.
3885  */
3886 function data_get_advance_search_ids($recordids, $searcharray, $dataid) {
3887     // Check to see if we have any record IDs.
3888     if (empty($recordids)) {
3889         // Send back an empty search.
3890         return array();
3891     }
3892     $searchcriteria = array_keys($searcharray);
3893     // Loop through and reduce the IDs one search criteria at a time.
3894     foreach ($searchcriteria as $key) {
3895         $recordids = data_get_recordids($key, $searcharray, $dataid, $recordids);
3896         // If we don't have anymore IDs then stop.
3897         if (!$recordids) {
3898             break;
3899         }
3900     }
3901     return $recordids;
3904 /**
3905  * Gets the record IDs given the search criteria
3906  *
3907  * @param string $alias       Record alias.
3908  * @param array $searcharray  Criteria for the search.
3909  * @param int $dataid         Data ID for the database
3910  * @param array $recordids    An array of record IDs.
3911  * @return array $nestarray   An arry of record IDs
3912  */
3913 function data_get_recordids($alias, $searcharray, $dataid, $recordids) {
3914     global $DB;
3915     $searchcriteria = $alias;   // Keep the criteria.
3916     $nestsearch = $searcharray[$alias];
3917     // searching for content outside of mdl_data_content
3918     if ($alias < 0) {
3919         $alias = '';
3920     }
3921     list($insql, $params) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3922     $nestselect = 'SELECT c' . $alias . '.recordid
3923                      FROM {data_content} c' . $alias . '
3924                INNER JOIN {data_fields} f
3925                        ON f.id = c' . $alias . '.fieldid
3926                INNER JOIN {data_records} r
3927                        ON r.id = c' . $alias . '.recordid
3928                INNER JOIN {user} u
3929                        ON u.id = r.userid ';
3930     $nestwhere = 'WHERE r.dataid = :dataid
3931                     AND c' . $alias .'.recordid ' . $insql . '
3932                     AND ';
3934     $params['dataid'] = $dataid;
3935     if (count($nestsearch->params) != 0) {
3936         $params = array_merge($params, $nestsearch->params);
3937         $nestsql = $nestselect . $nestwhere . $nestsearch->sql;
3938     } else if ($searchcriteria == DATA_TIMEMODIFIED) {
3939         $nestsql = $nestselect . $nestwhere . $nestsearch->field . ' >= :timemodified GROUP BY c' . $alias . '.recordid';
3940         $params['timemodified'] = $nestsearch->data;
3941     } else if ($searchcriteria == DATA_TAGS) {
3942         if (empty($nestsearch->rawtagnames)) {
3943             return [];
3944         }
3945         $i = 0;
3946         $tagwhere = [];
3947         $tagselect = '';
3948         foreach ($nestsearch->rawtagnames as $tagrawname) {
3949             $tagselect .= " INNER JOIN {tag_instance} ti_$i
3950                                     ON ti_$i.component = 'mod_data'
3951                                    AND ti_$i.itemtype = 'data_records'
3952                                    AND ti_$i.itemid = r.id
3953                             INNER JOIN {tag} t_$i
3954                                     ON ti_$i.tagid = t_$i.id ";
3955             $tagwhere[] = " t_$i.rawname = :trawname_$i ";
3956             $params["trawname_$i"] = $tagrawname;
3957             $i++;
3958         }
3959         $nestsql = $nestselect . $tagselect . $nestwhere . implode(' AND ', $tagwhere);
3960     } else {    // First name or last name.
3961         $thing = $DB->sql_like($nestsearch->field, ':search1', false);
3962         $nestsql = $nestselect . $nestwhere . $thing . ' GROUP BY c' . $alias . '.recordid';
3963         $params['search1'] = "%$nestsearch->data%";
3964     }
3965     $nestrecords = $DB->get_recordset_sql($nestsql, $params);
3966     $nestarray = array();
3967     foreach ($nestrecords as $data) {
3968         $nestarray[] = $data->recordid;
3969     }
3970     // Close the record set and free up resources.
3971     $nestrecords->close();
3972     return $nestarray;
3975 /**
3976  * Returns an array with an sql string for advanced searches and the parameters that go with them.
3977  *
3978  * @param int $sort            DATA_*
3979  * @param stdClass $data       Data module object
3980  * @param array $recordids     An array of record IDs.
3981  * @param string $selectdata   Information for the where and select part of the sql statement.
3982  * @param string $sortorder    Additional sort parameters
3983  * @return array sqlselect     sqlselect['sql'] has the sql string, sqlselect['params'] contains an array of parameters.
3984  */
3985 function data_get_advanced_search_sql($sort, $data, $recordids, $selectdata, $sortorder) {
3986     global $DB;
3988     $namefields = user_picture::fields('u');
3989     // Remove the id from the string. This already exists in the sql statement.
3990     $namefields = str_replace('u.id,', '', $namefields);
3992     if ($sort == 0) {
3993         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . '
3994                         FROM {data_content} c,
3995                              {data_records} r,
3996                              {user} u ';
3997         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' . $namefields;
3998     } else {
3999         // Sorting through 'Other' criteria
4000         if ($sort <= 0) {
4001             switch ($sort) {
4002                 case DATA_LASTNAME:
4003                     $sortcontentfull = "u.lastname";
4004                     break;
4005                 case DATA_FIRSTNAME:
4006                     $sortcontentfull = "u.firstname";
4007                     break;
4008                 case DATA_APPROVED:
4009                     $sortcontentfull = "r.approved";
4010                     break;
4011                 case DATA_TIMEMODIFIED:
4012                     $sortcontentfull = "r.timemodified";
4013                     break;
4014                 case DATA_TIMEADDED:
4015                 default:
4016                     $sortcontentfull = "r.timecreated";
4017             }
4018         } else {
4019             $sortfield = data_get_field_from_id($sort, $data);
4020             $sortcontent = $DB->sql_compare_text('c.' . $sortfield->get_sort_field());
4021             $sortcontentfull = $sortfield->get_sort_sql($sortcontent);
4022         }
4024         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . ',
4025                                  ' . $sortcontentfull . '
4026                               AS sortorder
4027                             FROM {data_content} c,
4028                                  {data_records} r,
4029                                  {user} u ';
4030         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . ', ' .$sortcontentfull;
4031     }
4033     // Default to a standard Where statement if $selectdata is empty.
4034     if ($selectdata == '') {
4035         $selectdata = 'WHERE c.recordid = r.id
4036                          AND r.dataid = :dataid
4037                          AND r.userid = u.id ';
4038     }
4040     // Find the field we are sorting on
4041     if ($sort > 0 or data_get_field_from_id($sort, $data)) {
4042         $selectdata .= ' AND c.fieldid = :sort';
4043     }
4045     // If there are no record IDs then return an sql statment that will return no rows.
4046     if (count($recordids) != 0) {
4047         list($insql, $inparam) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
4048     } else {
4049         list($insql, $inparam) = $DB->get_in_or_equal(array('-1'), SQL_PARAMS_NAMED);
4050     }
4051     $nestfromsql = $selectdata . ' AND c.recordid ' . $insql . $groupsql;
4052     $sqlselect['sql'] = "$nestselectsql $nestfromsql $sortorder";
4053     $sqlselect['params'] = $inparam;
4054     return $sqlselect;
4057 /**
4058  * Checks to see if the user has permission to delete the preset.
4059  * @param stdClass $context  Context object.
4060  * @param stdClass $preset  The preset object that we are checking for deletion.
4061  * @return bool  Returns true if the user can delete, otherwise false.
4062  */
4063 function data_user_can_delete_preset($context, $preset) {
4064     global $USER;
4066     if (has_capability('mod/data:manageuserpresets', $context)) {
4067         return true;
4068     } else {
4069         $candelete = false;
4070         if ($preset->userid == $USER->id) {
4071             $candelete = true;
4072         }
4073         return $candelete;
4074     }
4077 /**
4078  * Delete a record entry.
4079  *
4080  * @param int $recordid The ID for the record to be deleted.
4081  * @param object $data The data object for this activity.
4082  * @param int $courseid ID for the current course (for logging).
4083  * @param int $cmid The course module ID.
4084  * @return bool True if the record deleted, false if not.
4085  */
4086 function data_delete_record($recordid, $data, $courseid, $cmid) {
4087     global $DB, $CFG;
4089     if ($deleterecord = $DB->get_record('data_records', array('id' => $recordid))) {
4090         if ($deleterecord->dataid == $data->id) {
4091             if ($contents = $DB->get_records('data_content', array('recordid' => $deleterecord->id))) {
4092                 foreach ($contents as $content) {
4093                     if ($field = data_get_field_from_id($content->fieldid, $data)) {
4094                         $field->delete_content($content->recordid);
4095                     }
4096                 }
4097                 $DB->delete_records('data_content', array('recordid'=>$deleterecord->id));
4098                 $DB->delete_records('data_records', array('id'=>$deleterecord->id));
4100                 // Delete cached RSS feeds.
4101                 if (!empty($CFG->enablerssfeeds)) {
4102                     require_once($CFG->dirroot.'/mod/data/rsslib.php');
4103                     data_rss_delete_file($data);
4104                 }
4106                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $recordid);
4108                 // Trigger an event for deleting this record.
4109                 $event = \mod_data\event\record_deleted::create(array(
4110                     'objectid' => $deleterecord->id,
4111                     'context' => context_module::instance($cmid),
4112                     'courseid' => $courseid,
4113                     'other' => array(
4114                         'dataid' => $deleterecord->dataid
4115                     )
4116                 ));
4117                 $event->add_record_snapshot('data_records', $deleterecord);
4118                 $event->trigger();
4119                 $course = get_course($courseid);
4120                 $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
4121                 data_update_completion_state($data, $course, $cm);
4123                 return true;
4124             }
4125         }
4126     }
4128     return false;
4131 /**
4132  * Check for required fields, and build a list of fields to be updated in a
4133  * submission.
4134  *
4135  * @param $mod stdClass The current recordid - provided as an optimisation.
4136  * @param $fields array The field data
4137  * @param $datarecord stdClass The submitted data.
4138  * @return stdClass containing:
4139  * * string[] generalnotifications Notifications for the form as a whole.
4140  * * string[] fieldnotifications Notifications for a specific field.
4141  * * bool validated Whether the field was validated successfully.
4142  * * data_field_base[] fields The field objects to be update.
4143  */
4144 function data_process_submission(stdClass $mod, $fields, stdClass $datarecord) {
4145     $result = new stdClass();
4147     // Empty form checking - you can't submit an empty form.
4148     $emptyform = true;
4149     $requiredfieldsfilled = true;
4150     $fieldsvalidated = true;
4152     // Store the notifications.
4153     $result->generalnotifications = array();
4154     $result->fieldnotifications = array();
4156     // Store the instantiated classes as an optimisation when processing the result.
4157     // This prevents the fields being re-initialised when updating.
4158     $result->fields = array();
4160     $submitteddata = array();
4161     foreach ($datarecord as $fieldname => $fieldvalue) {
4162         if (strpos($fieldname, '_')) {
4163             $namearray = explode('_', $fieldname, 3);
4164             $fieldid = $namearray[1];
4165             if (!isset($submitteddata[$fieldid])) {
4166                 $submitteddata[$fieldid] = array();
4167             }
4168             if (count($namearray) === 2) {
4169                 $subfieldid = 0;
4170             } else {
4171                 $subfieldid = $namearray[2];
4172             }
4174             $fielddata = new stdClass();
4175             $fielddata->fieldname = $fieldname;
4176             $fielddata->value = $fieldvalue;
4177             $submitteddata[$fieldid][$subfieldid] = $fielddata;
4178         }
4179     }
4181     // Check all form fields which have the required are filled.
4182     foreach ($fields as $fieldrecord) {
4183         // Check whether the field has any data.
4184         $fieldhascontent = false;
4186         $field = data_get_field($fieldrecord, $mod);
4187         if (isset($submitteddata[$fieldrecord->id])) {
4188             // Field validation check.
4189             if (method_exists($field, 'field_validation')) {
4190                 $errormessage = $field->field_validation($submitteddata[$fieldrecord->id]);
4191                 if ($errormessage) {
4192                     $result->fieldnotifications[$field->field->name][] = $errormessage;
4193                     $fieldsvalidated = false;
4194                 }
4195             }
4196             foreach ($submitteddata[$fieldrecord->id] as $fieldname => $value) {
4197                 if ($field->notemptyfield($value->value, $value->fieldname)) {
4198                     // The field has content and the form is not empty.
4199                     $fieldhascontent = true;
4200                     $emptyform = false;
4201                 }
4202             }
4203         }
4205         // If the field is required, add a notification to that effect.
4206         if ($field->field->required && !$fieldhascontent) {
4207             if (!isset($result->fieldnotifications[$field->field->name])) {
4208                 $result->fieldnotifications[$field->field->name] = array();
4209             }
4210             $result->fieldnotifications[$field->field->name][] = get_string('errormustsupplyvalue', 'data');
4211             $requiredfieldsfilled = false;
4212         }
4214         // Update the field.
4215         if (isset($submitteddata[$fieldrecord->id])) {
4216             foreach ($submitteddata[$fieldrecord->id] as $value) {
4217                 $result->fields[$value->fieldname] = $field;
4218             }
4219         }
4220     }
4222     if ($emptyform) {
4223         // The form is empty.
4224         $result->generalnotifications[] = get_string('emptyaddform', 'data');
4225     }
4227     $result->validated = $requiredfieldsfilled && !$emptyform && $fieldsvalidated;
4229     return $result;
4232 /**
4233  * This standard function will check all instances of this module
4234  * and make sure there are up-to-date events created for each of them.
4235  * If courseid = 0, then every data event in the site is checked, else
4236  * only data events belonging to the course specified are checked.
4237  * This function is used, in its new format, by restore_refresh_events()
4238  *
4239  * @param int $courseid
4240  * @param int|stdClass $instance Data module instance or ID.
4241  * @param int|stdClass $cm Course module object or ID (not used in this module).
4242  * @return bool
4243  */
4244 function data_refresh_events($courseid = 0, $instance = null, $cm = null) {
4245     global $DB, $CFG;
4246     require_once($CFG->dirroot.'/mod/data/locallib.php');
4248     // If we have instance information then we can just update the one event instead of updating all events.
4249     if (isset($instance)) {
4250         if (!is_object($instance)) {
4251             $instance = $DB->get_record('data', array('id' => $instance), '*', MUST_EXIST);
4252         }
4253         data_set_events($instance);
4254         return true;
4255     }
4257     if ($courseid) {
4258         if (! $data = $DB->get_records("data", array("course" => $courseid))) {
4259             return true;
4260         }
4261     } else {
4262         if (! $data = $DB->get_records("data")) {
4263             return true;
4264         }
4265     }
4267     foreach ($data as $datum) {
4268         data_set_events($datum);
4269     }
4270     return true;
4273 /**
4274  * Fetch the configuration for this database activity.
4275  *
4276  * @param   stdClass    $database   The object returned from the database for this instance
4277  * @param   string      $key        The name of the key to retrieve. If none is supplied, then all configuration is returned
4278  * @param   mixed       $default    The default value to use if no value was found for the specified key
4279  * @return  mixed                   The returned value
4280  */
4281 function data_get_config($database, $key = null, $default = null) {
4282     if (!empty($database->config)) {
4283         $config = json_decode($database->config);
4284     } else {
4285         $config = new stdClass();
4286     }
4288     if ($key === null) {
4289         return $config;
4290     }
4292     if (property_exists($config, $key)) {
4293         return $config->$key;
4294     }
4295     return $default;
4298 /**
4299  * Update the configuration for this database activity.
4300  *
4301  * @param   stdClass    $database   The object returned from the database for this instance
4302  * @param   string      $key        The name of the key to set
4303  * @param   mixed       $value      The value to set for the key
4304  */
4305 function data_set_config(&$database, $key, $value) {
4306     // Note: We must pass $database by reference because there may be subsequent calls to update_record and these should
4307     // not overwrite the configuration just set.
4308     global $DB;
4310     $config = data_get_config($database);
4312     if (!isset($config->$key) || $config->$key !== $value) {
4313         $config->$key = $value;
4314         $database->config = json_encode($config);
4315         $DB->set_field('data', 'config', $database->config, ['id' => $database->id]);
4316     }
4318 /**
4319  * Sets the automatic completion state for this database item based on the
4320  * count of on its entries.
4321  * @since Moodle 3.3
4322  * @param object $data The data object for this activity