d1405936663e0f183e14bd6f917670c8d4df6349
[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 ##approvalstatusclass##';
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 = (object) [
1205             'time' => grade_get_date_for_user_grade($grade, $user),
1206         ];
1207         if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1208             $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1209         } else {
1210             $result->info = get_string('grade') . ': ' . get_string('hidden', 'grades');
1211         }
1213         return $result;
1214     }
1215     return NULL;
1218 /**
1219  * Prints all the records uploaded by this user
1220  *
1221  * @global object
1222  * @param object $course
1223  * @param object $user
1224  * @param object $mod
1225  * @param object $data
1226  */
1227 function data_user_complete($course, $user, $mod, $data) {
1228     global $DB, $CFG, $OUTPUT;
1229     require_once("$CFG->libdir/gradelib.php");
1231     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1232     if (!empty($grades->items[0]->grades)) {
1233         $grade = reset($grades->items[0]->grades);
1234         if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1235             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1236             if ($grade->str_feedback) {
1237                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1238             }
1239         } else {
1240             echo $OUTPUT->container(get_string('grade') . ': ' . get_string('hidden', 'grades'));
1241         }
1242     }
1244     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1245         data_print_template('singletemplate', $records, $data);
1246     }
1249 /**
1250  * Return grade for given user or all users.
1251  *
1252  * @global object
1253  * @param object $data
1254  * @param int $userid optional user id, 0 means all users
1255  * @return array array of grades, false if none
1256  */
1257 function data_get_user_grades($data, $userid=0) {
1258     global $CFG;
1260     require_once($CFG->dirroot.'/rating/lib.php');
1262     $ratingoptions = new stdClass;
1263     $ratingoptions->component = 'mod_data';
1264     $ratingoptions->ratingarea = 'entry';
1265     $ratingoptions->modulename = 'data';
1266     $ratingoptions->moduleid   = $data->id;
1268     $ratingoptions->userid = $userid;
1269     $ratingoptions->aggregationmethod = $data->assessed;
1270     $ratingoptions->scaleid = $data->scale;
1271     $ratingoptions->itemtable = 'data_records';
1272     $ratingoptions->itemtableusercolumn = 'userid';
1274     $rm = new rating_manager();
1275     return $rm->get_user_grades($ratingoptions);
1278 /**
1279  * Update activity grades
1280  *
1281  * @category grade
1282  * @param object $data
1283  * @param int $userid specific user only, 0 means all
1284  * @param bool $nullifnone
1285  */
1286 function data_update_grades($data, $userid=0, $nullifnone=true) {
1287     global $CFG, $DB;
1288     require_once($CFG->libdir.'/gradelib.php');
1290     if (!$data->assessed) {
1291         data_grade_item_update($data);
1293     } else if ($grades = data_get_user_grades($data, $userid)) {
1294         data_grade_item_update($data, $grades);
1296     } else if ($userid and $nullifnone) {
1297         $grade = new stdClass();
1298         $grade->userid   = $userid;
1299         $grade->rawgrade = NULL;
1300         data_grade_item_update($data, $grade);
1302     } else {
1303         data_grade_item_update($data);
1304     }
1307 /**
1308  * Update/create grade item for given data
1309  *
1310  * @category grade
1311  * @param stdClass $data A database instance with extra cmidnumber property
1312  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1313  * @return object grade_item
1314  */
1315 function data_grade_item_update($data, $grades=NULL) {
1316     global $CFG;
1317     require_once($CFG->libdir.'/gradelib.php');
1319     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1321     if (!$data->assessed or $data->scale == 0) {
1322         $params['gradetype'] = GRADE_TYPE_NONE;
1324     } else if ($data->scale > 0) {
1325         $params['gradetype'] = GRADE_TYPE_VALUE;
1326         $params['grademax']  = $data->scale;
1327         $params['grademin']  = 0;
1329     } else if ($data->scale < 0) {
1330         $params['gradetype'] = GRADE_TYPE_SCALE;
1331         $params['scaleid']   = -$data->scale;
1332     }
1334     if ($grades  === 'reset') {
1335         $params['reset'] = true;
1336         $grades = NULL;
1337     }
1339     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1342 /**
1343  * Delete grade item for given data
1344  *
1345  * @category grade
1346  * @param object $data object
1347  * @return object grade_item
1348  */
1349 function data_grade_item_delete($data) {
1350     global $CFG;
1351     require_once($CFG->libdir.'/gradelib.php');
1353     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1356 // junk functions
1357 /**
1358  * takes a list of records, the current data, a search string,
1359  * and mode to display prints the translated template
1360  *
1361  * @global object
1362  * @global object
1363  * @param string $template
1364  * @param array $records
1365  * @param object $data
1366  * @param string $search
1367  * @param int $page
1368  * @param bool $return
1369  * @param object $jumpurl a moodle_url by which to jump back to the record list (can be null)
1370  * @return mixed
1371  */
1372 function data_print_template($template, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null) {
1373     global $CFG, $DB, $OUTPUT;
1375     $cm = get_coursemodule_from_instance('data', $data->id);
1376     $context = context_module::instance($cm->id);
1378     static $fields = array();
1379     static $dataid = null;
1381     if (empty($dataid)) {
1382         $dataid = $data->id;
1383     } else if ($dataid != $data->id) {
1384         $fields = array();
1385     }
1387     if (empty($fields)) {
1388         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1389         foreach ($fieldrecords as $fieldrecord) {
1390             $fields[]= data_get_field($fieldrecord, $data);
1391         }
1392     }
1394     if (empty($records)) {
1395         return;
1396     }
1398     if (!$jumpurl) {
1399         $jumpurl = new moodle_url('/mod/data/view.php', array('d' => $data->id));
1400     }
1401     $jumpurl = new moodle_url($jumpurl, array('page' => $page, 'sesskey' => sesskey()));
1403     foreach ($records as $record) {   // Might be just one for the single template
1405     // Replacing tags
1406         $patterns = array();
1407         $replacement = array();
1409     // Then we generate strings to replace for normal tags
1410         foreach ($fields as $field) {
1411             $patterns[]='[['.$field->field->name.']]';
1412             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1413         }
1415         $canmanageentries = has_capability('mod/data:manageentries', $context);
1417     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1418         $patterns[]='##edit##';
1419         $patterns[]='##delete##';
1420         if (data_user_can_manage_entry($record, $data, $context)) {
1421             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1422                              .$data->id.'&amp;rid='.$record->id.'&amp;sesskey='.sesskey().'">' .
1423                              $OUTPUT->pix_icon('t/edit', get_string('edit')) . '</a>';
1424             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1425                              .$data->id.'&amp;delete='.$record->id.'&amp;sesskey='.sesskey().'">' .
1426                              $OUTPUT->pix_icon('t/delete', get_string('delete')) . '</a>';
1427         } else {
1428             $replacement[] = '';
1429             $replacement[] = '';
1430         }
1432         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1433         if ($search) {
1434             $moreurl .= '&amp;filter=1';
1435         }
1436         $patterns[]='##more##';
1437         $replacement[] = '<a href="'.$moreurl.'">' . $OUTPUT->pix_icon('t/preview', get_string('more', 'data')) . '</a>';
1439         $patterns[]='##moreurl##';
1440         $replacement[] = $moreurl;
1442         $patterns[]='##delcheck##';
1443         if ($canmanageentries) {
1444             $checkbox = new \core\output\checkbox_toggleall('listview-entries', false, [
1445                 'id' => "entry_{$record->id}",
1446                 'name' => 'delcheck[]',
1447                 'class' => 'recordcheckbox',
1448                 'value' => $record->id,
1449             ]);
1450             $replacement[] = $OUTPUT->render($checkbox);
1451         } else {
1452             $replacement[] = '';
1453         }
1455         $patterns[]='##user##';
1456         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1457                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1459         $patterns[] = '##userpicture##';
1460         $ruser = user_picture::unalias($record, null, 'userid');
1461         // If the record didn't come with user data, retrieve the user from database.
1462         if (!isset($ruser->picture)) {
1463             $ruser = core_user::get_user($record->userid);
1464         }
1465         $replacement[] = $OUTPUT->user_picture($ruser, array('courseid' => $data->course));
1467         $patterns[]='##export##';
1469         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1470             && ((has_capability('mod/data:exportentry', $context)
1471                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1472             require_once($CFG->libdir . '/portfoliolib.php');
1473             $button = new portfolio_add_button();
1474             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), 'mod_data');
1475             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1476             $button->set_formats($formats);
1477             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1478         } else {
1479             $replacement[] = '';
1480         }
1482         $patterns[] = '##timeadded##';
1483         $replacement[] = userdate($record->timecreated);
1485         $patterns[] = '##timemodified##';
1486         $replacement [] = userdate($record->timemodified);
1488         $patterns[]='##approve##';
1489         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)) {
1490             $approveurl = new moodle_url($jumpurl, array('approve' => $record->id));
1491             $approveicon = new pix_icon('t/approve', get_string('approve', 'data'), '', array('class' => 'iconsmall'));
1492             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($approveurl, $approveicon),
1493                     array('class' => 'approve'));
1494         } else {
1495             $replacement[] = '';
1496         }
1498         $patterns[]='##disapprove##';
1499         if (has_capability('mod/data:approve', $context) && ($data->approval) && ($record->approved)) {
1500             $disapproveurl = new moodle_url($jumpurl, array('disapprove' => $record->id));
1501             $disapproveicon = new pix_icon('t/block', get_string('disapprove', 'data'), '', array('class' => 'iconsmall'));
1502             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($disapproveurl, $disapproveicon),
1503                     array('class' => 'disapprove'));
1504         } else {
1505             $replacement[] = '';
1506         }
1508         $patterns[] = '##approvalstatus##';
1509         $patterns[] = '##approvalstatusclass##';
1510         if (!$data->approval) {
1511             $replacement[] = '';
1512             $replacement[] = '';
1513         } else if ($record->approved) {
1514             $replacement[] = get_string('approved', 'data');
1515             $replacement[] = 'approved';
1516         } else {
1517             $replacement[] = get_string('notapproved', 'data');
1518             $replacement[] = 'notapproved';
1519         }
1521         $patterns[]='##comments##';
1522         if (($template == 'listtemplate') && ($data->comments)) {
1524             if (!empty($CFG->usecomments)) {
1525                 require_once($CFG->dirroot  . '/comment/lib.php');
1526                 list($context, $course, $cm) = get_context_info_array($context->id);
1527                 $cmt = new stdClass();
1528                 $cmt->context = $context;
1529                 $cmt->course  = $course;
1530                 $cmt->cm      = $cm;
1531                 $cmt->area    = 'database_entry';
1532                 $cmt->itemid  = $record->id;
1533                 $cmt->showcount = true;
1534                 $cmt->component = 'mod_data';
1535                 $comment = new comment($cmt);
1536                 $replacement[] = $comment->output(true);
1537             }
1538         } else {
1539             $replacement[] = '';
1540         }
1542         if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1543             $patterns[] = "##tags##";
1544             $replacement[] = $OUTPUT->tag_list(
1545                 core_tag_tag::get_item_tags('mod_data', 'data_records', $record->id), '', 'data-tags');
1546         }
1548         // actual replacement of the tags
1549         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1551         // no more html formatting and filtering - see MDL-6635
1552         if ($return) {
1553             return $newtext;
1554         } else {
1555             echo $newtext;
1557             // hack alert - return is always false in singletemplate anyway ;-)
1558             /**********************************
1559              *    Printing Ratings Form       *
1560              *********************************/
1561             if ($template == 'singletemplate') {    //prints ratings options
1562                 data_print_ratings($data, $record);
1563             }
1565             /**********************************
1566              *    Printing Comments Form       *
1567              *********************************/
1568             if (($template == 'singletemplate') && ($data->comments)) {
1569                 if (!empty($CFG->usecomments)) {
1570                     require_once($CFG->dirroot . '/comment/lib.php');
1571                     list($context, $course, $cm) = get_context_info_array($context->id);
1572                     $cmt = new stdClass();
1573                     $cmt->context = $context;
1574                     $cmt->course  = $course;
1575                     $cmt->cm      = $cm;
1576                     $cmt->area    = 'database_entry';
1577                     $cmt->itemid  = $record->id;
1578                     $cmt->showcount = true;
1579                     $cmt->component = 'mod_data';
1580                     $comment = new comment($cmt);
1581                     $comment->output(false);
1582                 }
1583             }
1584         }
1585     }
1588 /**
1589  * Return rating related permissions
1590  *
1591  * @param string $contextid the context id
1592  * @param string $component the component to get rating permissions for
1593  * @param string $ratingarea the rating area to get permissions for
1594  * @return array an associative array of the user's rating permissions
1595  */
1596 function data_rating_permissions($contextid, $component, $ratingarea) {
1597     $context = context::instance_by_id($contextid, MUST_EXIST);
1598     if ($component != 'mod_data' || $ratingarea != 'entry') {
1599         return null;
1600     }
1601     return array(
1602         'view'    => has_capability('mod/data:viewrating',$context),
1603         'viewany' => has_capability('mod/data:viewanyrating',$context),
1604         'viewall' => has_capability('mod/data:viewallratings',$context),
1605         'rate'    => has_capability('mod/data:rate',$context)
1606     );
1609 /**
1610  * Validates a submitted rating
1611  * @param array $params submitted data
1612  *            context => object the context in which the rated items exists [required]
1613  *            itemid => int the ID of the object being rated
1614  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1615  *            rating => int the submitted rating
1616  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1617  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1618  * @return boolean true if the rating is valid. Will throw rating_exception if not
1619  */
1620 function data_rating_validate($params) {
1621     global $DB, $USER;
1623     // Check the component is mod_data
1624     if ($params['component'] != 'mod_data') {
1625         throw new rating_exception('invalidcomponent');
1626     }
1628     // Check the ratingarea is entry (the only rating area in data module)
1629     if ($params['ratingarea'] != 'entry') {
1630         throw new rating_exception('invalidratingarea');
1631     }
1633     // Check the rateduserid is not the current user .. you can't rate your own entries
1634     if ($params['rateduserid'] == $USER->id) {
1635         throw new rating_exception('nopermissiontorate');
1636     }
1638     $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
1639                   FROM {data_records} r
1640                   JOIN {data} d ON r.dataid = d.id
1641                  WHERE r.id = :itemid";
1642     $dataparams = array('itemid'=>$params['itemid']);
1643     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1644         //item doesn't exist
1645         throw new rating_exception('invaliditemid');
1646     }
1648     if ($info->scale != $params['scaleid']) {
1649         //the scale being submitted doesnt match the one in the database
1650         throw new rating_exception('invalidscaleid');
1651     }
1653     //check that the submitted rating is valid for the scale
1655     // lower limit
1656     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1657         throw new rating_exception('invalidnum');
1658     }
1660     // upper limit
1661     if ($info->scale < 0) {
1662         //its a custom scale
1663         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1664         if ($scalerecord) {
1665             $scalearray = explode(',', $scalerecord->scale);
1666             if ($params['rating'] > count($scalearray)) {
1667                 throw new rating_exception('invalidnum');
1668             }
1669         } else {
1670             throw new rating_exception('invalidscaleid');
1671         }
1672     } else if ($params['rating'] > $info->scale) {
1673         //if its numeric and submitted rating is above maximum
1674         throw new rating_exception('invalidnum');
1675     }
1677     if ($info->approval && !$info->approved) {
1678         //database requires approval but this item isnt approved
1679         throw new rating_exception('nopermissiontorate');
1680     }
1682     // check the item we're rating was created in the assessable time window
1683     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1684         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1685             throw new rating_exception('notavailable');
1686         }
1687     }
1689     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1690     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1691     $context = context_module::instance($cm->id);
1693     // if the supplied context doesnt match the item's context
1694     if ($context->id != $params['context']->id) {
1695         throw new rating_exception('invalidcontext');
1696     }
1698     // Make sure groups allow this user to see the item they're rating
1699     $groupid = $info->groupid;
1700     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1701         if (!groups_group_exists($groupid)) { // Can't find group
1702             throw new rating_exception('cannotfindgroup');//something is wrong
1703         }
1705         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1706             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1707             throw new rating_exception('notmemberofgroup');
1708         }
1709     }
1711     return true;
1714 /**
1715  * Can the current user see ratings for a given itemid?
1716  *
1717  * @param array $params submitted data
1718  *            contextid => int contextid [required]
1719  *            component => The component for this module - should always be mod_data [required]
1720  *            ratingarea => object the context in which the rated items exists [required]
1721  *            itemid => int the ID of the object being rated [required]
1722  *            scaleid => int scale id [optional]
1723  * @return bool
1724  * @throws coding_exception
1725  * @throws rating_exception
1726  */
1727 function mod_data_rating_can_see_item_ratings($params) {
1728     global $DB;
1730     // Check the component is mod_data.
1731     if (!isset($params['component']) || $params['component'] != 'mod_data') {
1732         throw new rating_exception('invalidcomponent');
1733     }
1735     // Check the ratingarea is entry (the only rating area in data).
1736     if (!isset($params['ratingarea']) || $params['ratingarea'] != 'entry') {
1737         throw new rating_exception('invalidratingarea');
1738     }
1740     if (!isset($params['itemid'])) {
1741         throw new rating_exception('invaliditemid');
1742     }
1744     $datasql = "SELECT d.id as dataid, d.course, r.groupid
1745                   FROM {data_records} r
1746                   JOIN {data} d ON r.dataid = d.id
1747                  WHERE r.id = :itemid";
1748     $dataparams = array('itemid' => $params['itemid']);
1749     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1750         // Item doesn't exist.
1751         throw new rating_exception('invaliditemid');
1752     }
1754     // User can see ratings of all participants.
1755     if ($info->groupid == 0) {
1756         return true;
1757     }
1759     $course = $DB->get_record('course', array('id' => $info->course), '*', MUST_EXIST);
1760     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1762     // Make sure groups allow this user to see the item they're rating.
1763     return groups_group_visible($info->groupid, $course, $cm);
1767 /**
1768  * function that takes in the current data, number of items per page,
1769  * a search string and prints a preference box in view.php
1770  *
1771  * This preference box prints a searchable advanced search template if
1772  *     a) A template is defined
1773  *  b) The advanced search checkbox is checked.
1774  *
1775  * @global object
1776  * @global object
1777  * @param object $data
1778  * @param int $perpage
1779  * @param string $search
1780  * @param string $sort
1781  * @param string $order
1782  * @param array $search_array
1783  * @param int $advanced
1784  * @param string $mode
1785  * @return void
1786  */
1787 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1788     global $CFG, $DB, $PAGE, $OUTPUT;
1790     $cm = get_coursemodule_from_instance('data', $data->id);
1791     $context = context_module::instance($cm->id);
1792     echo '<br /><div class="datapreferences">';
1793     echo '<form id="options" action="view.php" method="get">';
1794     echo '<div>';
1795     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1796     if ($mode =='asearch') {
1797         $advanced = 1;
1798         echo '<input type="hidden" name="mode" value="list" />';
1799     }
1800     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1801     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1802                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1803     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id' => 'pref_perpage', 'class' => 'custom-select'));
1805     if ($advanced) {
1806         $regsearchclass = 'search_none';
1807         $advancedsearchclass = 'search_inline';
1808     } else {
1809         $regsearchclass = 'search_inline';
1810         $advancedsearchclass = 'search_none';
1811     }
1812     echo '<div id="reg_search" class="' . $regsearchclass . ' form-inline" >&nbsp;&nbsp;&nbsp;';
1813     echo '<label for="pref_search">' . get_string('search') . '</label> <input type="text" ' .
1814          'class="form-control" size="16" name="search" id= "pref_search" value="' . s($search) . '" /></div>';
1815     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1816     // foreach field, print the option
1817     echo '<select name="sort" id="pref_sortby" class="custom-select mr-1">';
1818     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1819         echo '<optgroup label="'.get_string('fields', 'data').'">';
1820         foreach ($fields as $field) {
1821             if ($field->id == $sort) {
1822                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1823             } else {
1824                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1825             }
1826         }
1827         echo '</optgroup>';
1828     }
1829     $options = array();
1830     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1831     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1832     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1833     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1834     if ($data->approval and has_capability('mod/data:approve', $context)) {
1835         $options[DATA_APPROVED] = get_string('approved', 'data');
1836     }
1837     echo '<optgroup label="'.get_string('other', 'data').'">';
1838     foreach ($options as $key => $name) {
1839         if ($key == $sort) {
1840             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1841         } else {
1842             echo '<option value="'.$key.'">'.$name.'</option>';
1843         }
1844     }
1845     echo '</optgroup>';
1846     echo '</select>';
1847     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1848     echo '<select id="pref_order" name="order" class="custom-select mr-1">';
1849     if ($order == 'ASC') {
1850         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1851     } else {
1852         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1853     }
1854     if ($order == 'DESC') {
1855         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1856     } else {
1857         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1858     }
1859     echo '</select>';
1861     if ($advanced) {
1862         $checked = ' checked="checked" ';
1863     }
1864     else {
1865         $checked = '';
1866     }
1867     $PAGE->requires->js('/mod/data/data.js');
1868     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1869     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1870     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" ' . $checked . ' ' .
1871          'onchange="showHideAdvSearch(this.checked);" class="mx-1" />' .
1872          '<label for="advancedcheckbox">' . get_string('advancedsearch', 'data') . '</label>';
1873     echo '&nbsp;<input type="submit" class="btn btn-secondary" value="' . get_string('savesettings', 'data') . '" />';
1875     echo '<br />';
1876     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1877     echo '<table class="boxaligncenter">';
1879     // print ASC or DESC
1880     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1881     $i = 0;
1883     // Determine if we are printing all fields for advanced search, or the template for advanced search
1884     // If a template is not defined, use the deafault template and display all fields.
1885     if(empty($data->asearchtemplate)) {
1886         data_generate_default_template($data, 'asearchtemplate');
1887     }
1889     static $fields = array();
1890     static $dataid = null;
1892     if (empty($dataid)) {
1893         $dataid = $data->id;
1894     } else if ($dataid != $data->id) {
1895         $fields = array();
1896     }
1898     if (empty($fields)) {
1899         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1900         foreach ($fieldrecords as $fieldrecord) {
1901             $fields[]= data_get_field($fieldrecord, $data);
1902         }
1903     }
1905     // Replacing tags
1906     $patterns = array();
1907     $replacement = array();
1909     // Then we generate strings to replace for normal tags
1910     foreach ($fields as $field) {
1911         $fieldname = $field->field->name;
1912         $fieldname = preg_quote($fieldname, '/');
1913         $patterns[] = "/\[\[$fieldname\]\]/i";
1914         $searchfield = data_get_field_from_id($field->field->id, $data);
1915         if (!empty($search_array[$field->field->id]->data)) {
1916             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1917         } else {
1918             $replacement[] = $searchfield->display_search_field();
1919         }
1920     }
1921     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1922     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1923     $patterns[]    = '/##firstname##/';
1924     $replacement[] = '<label class="accesshide" for="u_fn">' . get_string('authorfirstname', 'data') . '</label>' .
1925                      '<input type="text" class="form-control" size="16" id="u_fn" name="u_fn" value="' . s($fn) . '" />';
1926     $patterns[]    = '/##lastname##/';
1927     $replacement[] = '<label class="accesshide" for="u_ln">' . get_string('authorlastname', 'data') . '</label>' .
1928                      '<input type="text" class="form-control" size="16" id="u_ln" name="u_ln" value="' . s($ln) . '" />';
1930     if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1931         $patterns[] = "/##tags##/";
1932         $selectedtags = isset($search_array[DATA_TAGS]->rawtagnames) ? $search_array[DATA_TAGS]->rawtagnames : [];
1933         $replacement[] = data_generate_tag_form(false, $selectedtags);
1934     }
1936     // actual replacement of the tags
1938     $options = new stdClass();
1939     $options->para=false;
1940     $options->noclean=true;
1941     echo '<tr><td>';
1942     echo preg_replace($patterns, $replacement, format_text($data->asearchtemplate, FORMAT_HTML, $options));
1943     echo '</td></tr>';
1945     echo '<tr><td colspan="4"><br/>' .
1946          '<input type="submit" class="btn btn-primary mr-1" value="' . get_string('savesettings', 'data') . '" />' .
1947          '<input type="submit" class="btn btn-secondary" name="resetadv" value="' . get_string('resetsettings', 'data') . '" />' .
1948          '</td></tr>';
1949     echo '</table>';
1950     echo '</div>';
1951     echo '</div>';
1952     echo '</form>';
1953     echo '</div>';
1956 /**
1957  * @global object
1958  * @global object
1959  * @param object $data
1960  * @param object $record
1961  * @return void Output echo'd
1962  */
1963 function data_print_ratings($data, $record) {
1964     global $OUTPUT;
1965     if (!empty($record->rating)){
1966         echo $OUTPUT->render($record->rating);
1967     }
1970 /**
1971  * List the actions that correspond to a view of this module.
1972  * This is used by the participation report.
1973  *
1974  * Note: This is not used by new logging system. Event with
1975  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1976  *       be considered as view action.
1977  *
1978  * @return array
1979  */
1980 function data_get_view_actions() {
1981     return array('view');
1984 /**
1985  * List the actions that correspond to a post of this module.
1986  * This is used by the participation report.
1987  *
1988  * Note: This is not used by new logging system. Event with
1989  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1990  *       will be considered as post action.
1991  *
1992  * @return array
1993  */
1994 function data_get_post_actions() {
1995     return array('add','update','record delete');
1998 /**
1999  * @param string $name
2000  * @param int $dataid
2001  * @param int $fieldid
2002  * @return bool
2003  */
2004 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
2005     global $DB;
2007     if (!is_numeric($name)) {
2008         $like = $DB->sql_like('df.name', ':name', false);
2009     } else {
2010         $like = "df.name = :name";
2011     }
2012     $params = array('name'=>$name);
2013     if ($fieldid) {
2014         $params['dataid']   = $dataid;
2015         $params['fieldid1'] = $fieldid;
2016         $params['fieldid2'] = $fieldid;
2017         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2018                                         WHERE $like AND df.dataid = :dataid
2019                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
2020     } else {
2021         $params['dataid']   = $dataid;
2022         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2023                                         WHERE $like AND df.dataid = :dataid", $params);
2024     }
2027 /**
2028  * @param array $fieldinput
2029  */
2030 function data_convert_arrays_to_strings(&$fieldinput) {
2031     foreach ($fieldinput as $key => $val) {
2032         if (is_array($val)) {
2033             $str = '';
2034             foreach ($val as $inner) {
2035                 $str .= $inner . ',';
2036             }
2037             $str = substr($str, 0, -1);
2039             $fieldinput->$key = $str;
2040         }
2041     }
2045 /**
2046  * Converts a database (module instance) to use the Roles System
2047  *
2048  * @global object
2049  * @global object
2050  * @uses CONTEXT_MODULE
2051  * @uses CAP_PREVENT
2052  * @uses CAP_ALLOW
2053  * @param object $data a data object with the same attributes as a record
2054  *                     from the data database table
2055  * @param int $datamodid the id of the data module, from the modules table
2056  * @param array $teacherroles array of roles that have archetype teacher
2057  * @param array $studentroles array of roles that have archetype student
2058  * @param array $guestroles array of roles that have archetype guest
2059  * @param int $cmid the course_module id for this data instance
2060  * @return boolean data module was converted or not
2061  */
2062 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
2063     global $CFG, $DB, $OUTPUT;
2065     if (!isset($data->participants) && !isset($data->assesspublic)
2066             && !isset($data->groupmode)) {
2067         // We assume that this database has already been converted to use the
2068         // Roles System. above fields get dropped the data module has been
2069         // upgraded to use Roles.
2070         return false;
2071     }
2073     if (empty($cmid)) {
2074         // We were not given the course_module id. Try to find it.
2075         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
2076             echo $OUTPUT->notification('Could not get the course module for the data');
2077             return false;
2078         } else {
2079             $cmid = $cm->id;
2080         }
2081     }
2082     $context = context_module::instance($cmid);
2085     // $data->participants:
2086     // 1 - Only teachers can add entries
2087     // 3 - Teachers and students can add entries
2088     switch ($data->participants) {
2089         case 1:
2090             foreach ($studentroles as $studentrole) {
2091                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
2092             }
2093             foreach ($teacherroles as $teacherrole) {
2094                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2095             }
2096             break;
2097         case 3:
2098             foreach ($studentroles as $studentrole) {
2099                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
2100             }
2101             foreach ($teacherroles as $teacherrole) {
2102                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2103             }
2104             break;
2105     }
2107     // $data->assessed:
2108     // 2 - Only teachers can rate posts
2109     // 1 - Everyone can rate posts
2110     // 0 - No one can rate posts
2111     switch ($data->assessed) {
2112         case 0:
2113             foreach ($studentroles as $studentrole) {
2114                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2115             }
2116             foreach ($teacherroles as $teacherrole) {
2117                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
2118             }
2119             break;
2120         case 1:
2121             foreach ($studentroles as $studentrole) {
2122                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
2123             }
2124             foreach ($teacherroles as $teacherrole) {
2125                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2126             }
2127             break;
2128         case 2:
2129             foreach ($studentroles as $studentrole) {
2130                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2131             }
2132             foreach ($teacherroles as $teacherrole) {
2133                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2134             }
2135             break;
2136     }
2138     // $data->assesspublic:
2139     // 0 - Students can only see their own ratings
2140     // 1 - Students can see everyone's ratings
2141     switch ($data->assesspublic) {
2142         case 0:
2143             foreach ($studentroles as $studentrole) {
2144                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
2145             }
2146             foreach ($teacherroles as $teacherrole) {
2147                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2148             }
2149             break;
2150         case 1:
2151             foreach ($studentroles as $studentrole) {
2152                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
2153             }
2154             foreach ($teacherroles as $teacherrole) {
2155                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2156             }
2157             break;
2158     }
2160     if (empty($cm)) {
2161         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
2162     }
2164     switch ($cm->groupmode) {
2165         case NOGROUPS:
2166             break;
2167         case SEPARATEGROUPS:
2168             foreach ($studentroles as $studentrole) {
2169                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
2170             }
2171             foreach ($teacherroles as $teacherrole) {
2172                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2173             }
2174             break;
2175         case VISIBLEGROUPS:
2176             foreach ($studentroles as $studentrole) {
2177                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
2178             }
2179             foreach ($teacherroles as $teacherrole) {
2180                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2181             }
2182             break;
2183     }
2184     return true;
2187 /**
2188  * Returns the best name to show for a preset
2189  *
2190  * @param string $shortname
2191  * @param  string $path
2192  * @return string
2193  */
2194 function data_preset_name($shortname, $path) {
2196     // We are looking inside the preset itself as a first choice, but also in normal data directory
2197     $string = get_string('modulename', 'datapreset_'.$shortname);
2199     if (substr($string, 0, 1) == '[') {
2200         return $shortname;
2201     } else {
2202         return $string;
2203     }
2206 /**
2207  * Returns an array of all the available presets.
2208  *
2209  * @return array
2210  */
2211 function data_get_available_presets($context) {
2212     global $CFG, $USER;
2214     $presets = array();
2216     // First load the ratings sub plugins that exist within the modules preset dir
2217     if ($dirs = core_component::get_plugin_list('datapreset')) {
2218         foreach ($dirs as $dir=>$fulldir) {
2219             if (is_directory_a_preset($fulldir)) {
2220                 $preset = new stdClass();
2221                 $preset->path = $fulldir;
2222                 $preset->userid = 0;
2223                 $preset->shortname = $dir;
2224                 $preset->name = data_preset_name($dir, $fulldir);
2225                 if (file_exists($fulldir.'/screenshot.jpg')) {
2226                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
2227                 } else if (file_exists($fulldir.'/screenshot.png')) {
2228                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
2229                 } else if (file_exists($fulldir.'/screenshot.gif')) {
2230                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
2231                 }
2232                 $presets[] = $preset;
2233             }
2234         }
2235     }
2236     // Now add to that the site presets that people have saved
2237     $presets = data_get_available_site_presets($context, $presets);
2238     return $presets;
2241 /**
2242  * Gets an array of all of the presets that users have saved to the site.
2243  *
2244  * @param stdClass $context The context that we are looking from.
2245  * @param array $presets
2246  * @return array An array of presets
2247  */
2248 function data_get_available_site_presets($context, array $presets=array()) {
2249     global $USER;
2251     $fs = get_file_storage();
2252     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2253     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
2254     if (empty($files)) {
2255         return $presets;
2256     }
2257     foreach ($files as $file) {
2258         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
2259             continue;
2260         }
2261         $preset = new stdClass;
2262         $preset->path = $file->get_filepath();
2263         $preset->name = trim($preset->path, '/');
2264         $preset->shortname = $preset->name;
2265         $preset->userid = $file->get_userid();
2266         $preset->id = $file->get_id();
2267         $preset->storedfile = $file;
2268         $presets[] = $preset;
2269     }
2270     return $presets;
2273 /**
2274  * Deletes a saved preset.
2275  *
2276  * @param string $name
2277  * @return bool
2278  */
2279 function data_delete_site_preset($name) {
2280     $fs = get_file_storage();
2282     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
2283     if (!empty($files)) {
2284         foreach ($files as $file) {
2285             $file->delete();
2286         }
2287     }
2289     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
2290     if (!empty($dir)) {
2291         $dir->delete();
2292     }
2293     return true;
2296 /**
2297  * Prints the heads for a page
2298  *
2299  * @param stdClass $course
2300  * @param stdClass $cm
2301  * @param stdClass $data
2302  * @param string $currenttab
2303  */
2304 function data_print_header($course, $cm, $data, $currenttab='') {
2306     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
2308     $PAGE->set_title($data->name);
2309     echo $OUTPUT->header();
2310     echo $OUTPUT->heading(format_string($data->name), 2);
2311     echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro');
2313     // Groups needed for Add entry tab
2314     $currentgroup = groups_get_activity_group($cm);
2315     $groupmode = groups_get_activity_groupmode($cm);
2317     // Print the tabs
2319     if ($currenttab) {
2320         include('tabs.php');
2321     }
2323     // Print any notices
2325     if (!empty($displaynoticegood)) {
2326         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
2327     } else if (!empty($displaynoticebad)) {
2328         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
2329     }
2332 /**
2333  * Can user add more entries?
2334  *
2335  * @param object $data
2336  * @param mixed $currentgroup
2337  * @param int $groupmode
2338  * @param stdClass $context
2339  * @return bool
2340  */
2341 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2342     global $USER;
2344     if (empty($context)) {
2345         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2346         $context = context_module::instance($cm->id);
2347     }
2349     if (has_capability('mod/data:manageentries', $context)) {
2350         // no entry limits apply if user can manage
2352     } else if (!has_capability('mod/data:writeentry', $context)) {
2353         return false;
2355     } else if (data_atmaxentries($data)) {
2356         return false;
2357     } else if (data_in_readonly_period($data)) {
2358         // Check whether we're in a read-only period
2359         return false;
2360     }
2362     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2363         return true;
2364     }
2366     if ($currentgroup) {
2367         return groups_is_member($currentgroup);
2368     } else {
2369         //else it might be group 0 in visible mode
2370         if ($groupmode == VISIBLEGROUPS){
2371             return true;
2372         } else {
2373             return false;
2374         }
2375     }
2378 /**
2379  * Check whether the current user is allowed to manage the given record considering manageentries capability,
2380  * data_in_readonly_period() result, ownership (determined by data_isowner()) and manageapproved setting.
2381  * @param mixed $record record object or id
2382  * @param object $data data object
2383  * @param object $context context object
2384  * @return bool returns true if the user is allowd to edit the entry, false otherwise
2385  */
2386 function data_user_can_manage_entry($record, $data, $context) {
2387     global $DB;
2389     if (has_capability('mod/data:manageentries', $context)) {
2390         return true;
2391     }
2393     // Check whether this activity is read-only at present.
2394     $readonly = data_in_readonly_period($data);
2396     if (!$readonly) {
2397         // Get record object from db if just id given like in data_isowner.
2398         // ...done before calling data_isowner() to avoid querying db twice.
2399         if (!is_object($record)) {
2400             if (!$record = $DB->get_record('data_records', array('id' => $record))) {
2401                 return false;
2402             }
2403         }
2404         if (data_isowner($record)) {
2405             if ($data->approval && $record->approved) {
2406                 return $data->manageapproved == 1;
2407             } else {
2408                 return true;
2409             }
2410         }
2411     }
2413     return false;
2416 /**
2417  * Check whether the specified database activity is currently in a read-only period
2418  *
2419  * @param object $data
2420  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2421  */
2422 function data_in_readonly_period($data) {
2423     $now = time();
2424     if (!$data->timeviewfrom && !$data->timeviewto) {
2425         return false;
2426     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2427         return false;
2428     }
2429     return true;
2432 /**
2433  * @return bool
2434  */
2435 function is_directory_a_preset($directory) {
2436     $directory = rtrim($directory, '/\\') . '/';
2437     $status = file_exists($directory.'singletemplate.html') &&
2438               file_exists($directory.'listtemplate.html') &&
2439               file_exists($directory.'listtemplateheader.html') &&
2440               file_exists($directory.'listtemplatefooter.html') &&
2441               file_exists($directory.'addtemplate.html') &&
2442               file_exists($directory.'rsstemplate.html') &&
2443               file_exists($directory.'rsstitletemplate.html') &&
2444               file_exists($directory.'csstemplate.css') &&
2445               file_exists($directory.'jstemplate.js') &&
2446               file_exists($directory.'preset.xml');
2448     return $status;
2451 /**
2452  * Abstract class used for data preset importers
2453  */
2454 abstract class data_preset_importer {
2456     protected $course;
2457     protected $cm;
2458     protected $module;
2459     protected $directory;
2461     /**
2462      * Constructor
2463      *
2464      * @param stdClass $course
2465      * @param stdClass $cm
2466      * @param stdClass $module
2467      * @param string $directory
2468      */
2469     public function __construct($course, $cm, $module, $directory) {
2470         $this->course = $course;
2471         $this->cm = $cm;
2472         $this->module = $module;
2473         $this->directory = $directory;
2474     }
2476     /**
2477      * Returns the name of the directory the preset is located in
2478      * @return string
2479      */
2480     public function get_directory() {
2481         return basename($this->directory);
2482     }
2484     /**
2485      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2486      * @param file_storage $filestorage. should be null if using a conventional directory
2487      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2488      * @param string $dir the directory to look in. null if using the Moodle file storage
2489      * @param string $filename the name of the file we want
2490      * @return string the contents of the file or null if the file doesn't exist.
2491      */
2492     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2493         if(empty($filestorage) || empty($fileobj)) {
2494             if (substr($dir, -1)!='/') {
2495                 $dir .= '/';
2496             }
2497             if (file_exists($dir.$filename)) {
2498                 return file_get_contents($dir.$filename);
2499             } else {
2500                 return null;
2501             }
2502         } else {
2503             if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
2504                 $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2505                 return $file->get_content();
2506             } else {
2507                 return null;
2508             }
2509         }
2511     }
2512     /**
2513      * Gets the preset settings
2514      * @global moodle_database $DB
2515      * @return stdClass
2516      */
2517     public function get_preset_settings() {
2518         global $DB;
2520         $fs = $fileobj = null;
2521         if (!is_directory_a_preset($this->directory)) {
2522             //maybe the user requested a preset stored in the Moodle file storage
2524             $fs = get_file_storage();
2525             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2527             //preset name to find will be the final element of the directory
2528             $explodeddirectory = explode('/', $this->directory);
2529             $presettofind = end($explodeddirectory);
2531             //now go through the available files available and see if we can find it
2532             foreach ($files as $file) {
2533                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2534                     continue;
2535                 }
2536                 $presetname = trim($file->get_filepath(), '/');
2537                 if ($presetname==$presettofind) {
2538                     $this->directory = $presetname;
2539                     $fileobj = $file;
2540                 }
2541             }
2543             if (empty($fileobj)) {
2544                 print_error('invalidpreset', 'data', '', $this->directory);
2545             }
2546         }
2548         $allowed_settings = array(
2549             'intro',
2550             'comments',
2551             'requiredentries',
2552             'requiredentriestoview',
2553             'maxentries',
2554             'rssarticles',
2555             'approval',
2556             'defaultsortdir',
2557             'defaultsort');
2559         $result = new stdClass;
2560         $result->settings = new stdClass;
2561         $result->importfields = array();
2562         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2563         if (!$result->currentfields) {
2564             $result->currentfields = array();
2565         }
2568         /* Grab XML */
2569         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2570         $parsedxml = xmlize($presetxml, 0);
2572         /* First, do settings. Put in user friendly array. */
2573         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2574         $result->settings = new StdClass();
2575         foreach ($settingsarray as $setting => $value) {
2576             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2577                 // unsupported setting
2578                 continue;
2579             }
2580             $result->settings->$setting = $value[0]['#'];
2581         }
2583         /* Now work out fields to user friendly array */
2584         $fieldsarray = $parsedxml['preset']['#']['field'];
2585         foreach ($fieldsarray as $field) {
2586             if (!is_array($field)) {
2587                 continue;
2588             }
2589             $f = new StdClass();
2590             foreach ($field['#'] as $param => $value) {
2591                 if (!is_array($value)) {
2592                     continue;
2593                 }
2594                 $f->$param = $value[0]['#'];
2595             }
2596             $f->dataid = $this->module->id;
2597             $f->type = clean_param($f->type, PARAM_ALPHA);
2598             $result->importfields[] = $f;
2599         }
2600         /* Now add the HTML templates to the settings array so we can update d */
2601         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2602         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2603         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2604         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2605         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2606         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2607         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2608         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2609         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2610         $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2612         $result->settings->instance = $this->module->id;
2613         return $result;
2614     }
2616     /**
2617      * Import the preset into the given database module
2618      * @return bool
2619      */
2620     function import($overwritesettings) {
2621         global $DB, $CFG;
2623         $params = $this->get_preset_settings();
2624         $settings = $params->settings;
2625         $newfields = $params->importfields;
2626         $currentfields = $params->currentfields;
2627         $preservedfields = array();
2629         /* Maps fields and makes new ones */
2630         if (!empty($newfields)) {
2631             /* We require an injective mapping, and need to know what to protect */
2632             foreach ($newfields as $nid => $newfield) {
2633                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2634                 if ($cid == -1) {
2635                     continue;
2636                 }
2637                 if (array_key_exists($cid, $preservedfields)){
2638                     print_error('notinjectivemap', 'data');
2639                 }
2640                 else $preservedfields[$cid] = true;
2641             }
2643             foreach ($newfields as $nid => $newfield) {
2644                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2646                 /* A mapping. Just need to change field params. Data kept. */
2647                 if ($cid != -1 and isset($currentfields[$cid])) {
2648                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2649                     foreach ($newfield as $param => $value) {
2650                         if ($param != "id") {
2651                             $fieldobject->field->$param = $value;
2652                         }
2653                     }
2654                     unset($fieldobject->field->similarfield);
2655                     $fieldobject->update_field();
2656                     unset($fieldobject);
2657                 } else {
2658                     /* Make a new field */
2659                     include_once("field/$newfield->type/field.class.php");
2661                     if (!isset($newfield->description)) {
2662                         $newfield->description = '';
2663                     }
2664                     $classname = 'data_field_'.$newfield->type;
2665                     $fieldclass = new $classname($newfield, $this->module);
2666                     $fieldclass->insert_field();
2667                     unset($fieldclass);
2668                 }
2669             }
2670         }
2672         /* Get rid of all old unused data */
2673         if (!empty($preservedfields)) {
2674             foreach ($currentfields as $cid => $currentfield) {
2675                 if (!array_key_exists($cid, $preservedfields)) {
2676                     /* Data not used anymore so wipe! */
2677                     print "Deleting field $currentfield->name<br />";
2679                     $id = $currentfield->id;
2680                     //Why delete existing data records and related comments/ratings??
2681                     $DB->delete_records('data_content', array('fieldid'=>$id));
2682                     $DB->delete_records('data_fields', array('id'=>$id));
2683                 }
2684             }
2685         }
2687         // handle special settings here
2688         if (!empty($settings->defaultsort)) {
2689             if (is_numeric($settings->defaultsort)) {
2690                 // old broken value
2691                 $settings->defaultsort = 0;
2692             } else {
2693                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2694             }
2695         } else {
2696             $settings->defaultsort = 0;
2697         }
2699         // do we want to overwrite all current database settings?
2700         if ($overwritesettings) {
2701             // all supported settings
2702             $overwrite = array_keys((array)$settings);
2703         } else {
2704             // only templates and sorting
2705             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2706                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2707                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2708         }
2710         // now overwrite current data settings
2711         foreach ($this->module as $prop=>$unused) {
2712             if (in_array($prop, $overwrite)) {
2713                 $this->module->$prop = $settings->$prop;
2714             }
2715         }
2717         data_update_instance($this->module);
2719         return $this->cleanup();
2720     }
2722     /**
2723      * Any clean up routines should go here
2724      * @return bool
2725      */
2726     public function cleanup() {
2727         return true;
2728     }
2731 /**
2732  * Data preset importer for uploaded presets
2733  */
2734 class data_preset_upload_importer extends data_preset_importer {
2735     public function __construct($course, $cm, $module, $filepath) {
2736         global $USER;
2737         if (is_file($filepath)) {
2738             $fp = get_file_packer();
2739             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2740                 fulldelete($filepath);
2741             }
2742             $filepath .= '_extracted';
2743         }
2744         parent::__construct($course, $cm, $module, $filepath);
2745     }
2746     public function cleanup() {
2747         return fulldelete($this->directory);
2748     }
2751 /**
2752  * Data preset importer for existing presets
2753  */
2754 class data_preset_existing_importer extends data_preset_importer {
2755     protected $userid;
2756     public function __construct($course, $cm, $module, $fullname) {
2757         global $USER;
2758         list($userid, $shortname) = explode('/', $fullname, 2);
2759         $context = context_module::instance($cm->id);
2760         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2761            throw new coding_exception('Invalid preset provided');
2762         }
2764         $this->userid = $userid;
2765         $filepath = data_preset_path($course, $userid, $shortname);
2766         parent::__construct($course, $cm, $module, $filepath);
2767     }
2768     public function get_userid() {
2769         return $this->userid;
2770     }
2773 /**
2774  * @global object
2775  * @global object
2776  * @param object $course
2777  * @param int $userid
2778  * @param string $shortname
2779  * @return string
2780  */
2781 function data_preset_path($course, $userid, $shortname) {
2782     global $USER, $CFG;
2784     $context = context_course::instance($course->id);
2786     $userid = (int)$userid;
2788     $path = null;
2789     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2790         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2791     } else if ($userid == 0) {
2792         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2793     } else if ($userid < 0) {
2794         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2795     }
2797     return $path;
2800 /**
2801  * Implementation of the function for printing the form elements that control
2802  * whether the course reset functionality affects the data.
2803  *
2804  * @param $mform form passed by reference
2805  */
2806 function data_reset_course_form_definition(&$mform) {
2807     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2808     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2810     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2811     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2813     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2814     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2816     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2817     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2819     $mform->addElement('checkbox', 'reset_data_tags', get_string('removealldatatags', 'data'));
2820     $mform->disabledIf('reset_data_tags', 'reset_data', 'checked');
2823 /**
2824  * Course reset form defaults.
2825  * @return array
2826  */
2827 function data_reset_course_form_defaults($course) {
2828     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2831 /**
2832  * Removes all grades from gradebook
2833  *
2834  * @global object
2835  * @global object
2836  * @param int $courseid
2837  * @param string $type optional type
2838  */
2839 function data_reset_gradebook($courseid, $type='') {
2840     global $CFG, $DB;
2842     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2843               FROM {data} d, {course_modules} cm, {modules} m
2844              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2846     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2847         foreach ($datas as $data) {
2848             data_grade_item_update($data, 'reset');
2849         }
2850     }
2853 /**
2854  * Actual implementation of the reset course functionality, delete all the
2855  * data responses for course $data->courseid.
2856  *
2857  * @global object
2858  * @global object
2859  * @param object $data the data submitted from the reset course.
2860  * @return array status array
2861  */
2862 function data_reset_userdata($data) {
2863     global $CFG, $DB;
2864     require_once($CFG->libdir.'/filelib.php');
2865     require_once($CFG->dirroot.'/rating/lib.php');
2867     $componentstr = get_string('modulenameplural', 'data');
2868     $status = array();
2870     $allrecordssql = "SELECT r.id
2871                         FROM {data_records} r
2872                              INNER JOIN {data} d ON r.dataid = d.id
2873                        WHERE d.course = ?";
2875     $alldatassql = "SELECT d.id
2876                       FROM {data} d
2877                      WHERE d.course=?";
2879     $rm = new rating_manager();
2880     $ratingdeloptions = new stdClass;
2881     $ratingdeloptions->component = 'mod_data';
2882     $ratingdeloptions->ratingarea = 'entry';
2884     // Set the file storage - may need it to remove files later.
2885     $fs = get_file_storage();
2887     // delete entries if requested
2888     if (!empty($data->reset_data)) {
2889         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2890         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2891         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2893         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2894             foreach ($datas as $dataid=>$unused) {
2895                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2896                     continue;
2897                 }
2898                 $datacontext = context_module::instance($cm->id);
2900                 // Delete any files that may exist.
2901                 $fs->delete_area_files($datacontext->id, 'mod_data', 'content');
2903                 $ratingdeloptions->contextid = $datacontext->id;
2904                 $rm->delete_ratings($ratingdeloptions);
2906                 core_tag_tag::delete_instances('mod_data', null, $datacontext->id);
2907             }
2908         }
2910         if (empty($data->reset_gradebook_grades)) {
2911             // remove all grades from gradebook
2912             data_reset_gradebook($data->courseid);
2913         }
2914         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2915     }
2917     // remove entries by users not enrolled into course
2918     if (!empty($data->reset_data_notenrolled)) {
2919         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2920                          FROM {data_records} r
2921                               JOIN {data} d ON r.dataid = d.id
2922                               LEFT JOIN {user} u ON r.userid = u.id
2923                         WHERE d.course = ? AND r.userid > 0";
2925         $course_context = context_course::instance($data->courseid);
2926         $notenrolled = array();
2927         $fields = array();
2928         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2929         foreach ($rs as $record) {
2930             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2931               or !is_enrolled($course_context, $record->userid)) {
2932                 //delete ratings
2933                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2934                     continue;
2935                 }
2936                 $datacontext = context_module::instance($cm->id);
2937                 $ratingdeloptions->contextid = $datacontext->id;
2938                 $ratingdeloptions->itemid = $record->id;
2939                 $rm->delete_ratings($ratingdeloptions);
2941                 // Delete any files that may exist.
2942                 if ($contents = $DB->get_records('data_content', array('recordid' => $record->id), '', 'id')) {
2943                     foreach ($contents as $content) {
2944                         $fs->delete_area_files($datacontext->id, 'mod_data', 'content', $content->id);
2945                     }
2946                 }
2947                 $notenrolled[$record->userid] = true;
2949                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $record->id);
2951                 $DB->delete_records('comments', array('itemid' => $record->id, 'commentarea' => 'database_entry'));
2952                 $DB->delete_records('data_content', array('recordid' => $record->id));
2953                 $DB->delete_records('data_records', array('id' => $record->id));
2954             }
2955         }
2956         $rs->close();
2957         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2958     }
2960     // remove all ratings
2961     if (!empty($data->reset_data_ratings)) {
2962         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2963             foreach ($datas as $dataid=>$unused) {
2964                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2965                     continue;
2966                 }
2967                 $datacontext = context_module::instance($cm->id);
2969                 $ratingdeloptions->contextid = $datacontext->id;
2970                 $rm->delete_ratings($ratingdeloptions);
2971             }
2972         }
2974         if (empty($data->reset_gradebook_grades)) {
2975             // remove all grades from gradebook
2976             data_reset_gradebook($data->courseid);
2977         }
2979         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2980     }
2982     // remove all comments
2983     if (!empty($data->reset_data_comments)) {
2984         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2985         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2986     }
2988     // Remove all the tags.
2989     if (!empty($data->reset_data_tags)) {
2990         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2991             foreach ($datas as $dataid => $unused) {
2992                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2993                     continue;
2994                 }
2996                 $context = context_module::instance($cm->id);
2997                 core_tag_tag::delete_instances('mod_data', null, $context->id);
2999             }
3000         }
3001         $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'data'), 'error' => false);
3002     }
3004     // updating dates - shift may be negative too
3005     if ($data->timeshift) {
3006         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
3007         // See MDL-9367.
3008         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto',
3009             'timeviewfrom', 'timeviewto', 'assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
3010         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3011     }
3013     return $status;
3016 /**
3017  * Returns all other caps used in module
3018  *
3019  * @return array
3020  */
3021 function data_get_extra_capabilities() {
3022     return ['moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate',
3023             'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete'];
3026 /**
3027  * @param string $feature FEATURE_xx constant for requested feature
3028  * @return mixed True if module supports feature, null if doesn't know
3029  */
3030 function data_supports($feature) {
3031     switch($feature) {
3032         case FEATURE_GROUPS:                  return true;
3033         case FEATURE_GROUPINGS:               return true;
3034         case FEATURE_MOD_INTRO:               return true;
3035         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
3036         case FEATURE_COMPLETION_HAS_RULES:    return true;
3037         case FEATURE_GRADE_HAS_GRADE:         return true;
3038         case FEATURE_GRADE_OUTCOMES:          return true;
3039         case FEATURE_RATE:                    return true;
3040         case FEATURE_BACKUP_MOODLE2:          return true;
3041         case FEATURE_SHOW_DESCRIPTION:        return true;
3042         case FEATURE_COMMENT:                 return true;
3044         default: return null;
3045     }
3047 /**
3048  * @global object
3049  * @param array $export
3050  * @param string $delimiter_name
3051  * @param object $database
3052  * @param int $count
3053  * @param bool $return
3054  * @return string|void
3055  */
3056 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
3057     global $CFG;
3058     require_once($CFG->libdir . '/csvlib.class.php');
3060     $filename = $database . '-' . $count . '-record';
3061     if ($count > 1) {
3062         $filename .= 's';
3063     }
3064     if ($return) {
3065         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
3066     } else {
3067         csv_export_writer::download_array($filename, $export, $delimiter_name);
3068     }
3071 /**
3072  * @global object
3073  * @param array $export
3074  * @param string $dataname
3075  * @param int $count
3076  * @return string
3077  */
3078 function data_export_xls($export, $dataname, $count) {
3079     global $CFG;
3080     require_once("$CFG->libdir/excellib.class.php");
3081     $filename = clean_filename("{$dataname}-{$count}_record");
3082     if ($count > 1) {
3083         $filename .= 's';
3084     }
3085     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3086     $filename .= '.xls';
3088     $filearg = '-';
3089     $workbook = new MoodleExcelWorkbook($filearg);
3090     $workbook->send($filename);
3091     $worksheet = array();
3092     $worksheet[0] = $workbook->add_worksheet('');
3093     $rowno = 0;
3094     foreach ($export as $row) {
3095         $colno = 0;
3096         foreach($row as $col) {
3097             $worksheet[0]->write($rowno, $colno, $col);
3098             $colno++;
3099         }
3100         $rowno++;
3101     }
3102     $workbook->close();
3103     return $filename;
3106 /**
3107  * @global object
3108  * @param array $export
3109  * @param string $dataname
3110  * @param int $count
3111  * @param string
3112  */
3113 function data_export_ods($export, $dataname, $count) {
3114     global $CFG;
3115     require_once("$CFG->libdir/odslib.class.php");
3116     $filename = clean_filename("{$dataname}-{$count}_record");
3117     if ($count > 1) {
3118         $filename .= 's';
3119     }
3120     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3121     $filename .= '.ods';
3122     $filearg = '-';
3123     $workbook = new MoodleODSWorkbook($filearg);
3124     $workbook->send($filename);
3125     $worksheet = array();
3126     $worksheet[0] = $workbook->add_worksheet('');
3127     $rowno = 0;
3128     foreach ($export as $row) {
3129         $colno = 0;
3130         foreach($row as $col) {
3131             $worksheet[0]->write($rowno, $colno, $col);
3132             $colno++;
3133         }
3134         $rowno++;
3135     }
3136     $workbook->close();
3137     return $filename;
3140 /**
3141  * @global object
3142  * @param int $dataid
3143  * @param array $fields
3144  * @param array $selectedfields
3145  * @param int $currentgroup group ID of the current group. This is used for
3146  * exporting data while maintaining group divisions.
3147  * @param object $context the context in which the operation is performed (for capability checks)
3148  * @param bool $userdetails whether to include the details of the record author
3149  * @param bool $time whether to include time created/modified
3150  * @param bool $approval whether to include approval status
3151  * @param bool $tags whether to include tags
3152  * @return array
3153  */
3154 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
3155                              $userdetails=false, $time=false, $approval=false, $tags = false) {
3156     global $DB;
3158     if (is_null($context)) {
3159         $context = context_system::instance();
3160     }
3161     // exporting user data needs special permission
3162     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
3164     $exportdata = array();
3166     // populate the header in first row of export
3167     foreach($fields as $key => $field) {
3168         if (!in_array($field->field->id, $selectedfields)) {
3169             // ignore values we aren't exporting
3170             unset($fields[$key]);
3171         } else {
3172             $exportdata[0][] = $field->field->name;
3173         }
3174     }
3175     if ($tags) {
3176         $exportdata[0][] = get_string('tags', 'data');
3177     }
3178     if ($userdetails) {
3179         $exportdata[0][] = get_string('user');
3180         $exportdata[0][] = get_string('username');
3181         $exportdata[0][] = get_string('email');
3182     }
3183     if ($time) {
3184         $exportdata[0][] = get_string('timeadded', 'data');
3185         $exportdata[0][] = get_string('timemodified', 'data');
3186     }
3187     if ($approval) {
3188         $exportdata[0][] = get_string('approved', 'data');
3189     }
3191     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
3192     ksort($datarecords);
3193     $line = 1;
3194     foreach($datarecords as $record) {
3195         // get content indexed by fieldid
3196         if ($currentgroup) {
3197             $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 = ?';
3198             $where = array($record->id, $currentgroup);
3199         } else {
3200             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
3201             $where = array($record->id);
3202         }
3204         if( $content = $DB->get_records_sql($select, $where) ) {
3205             foreach($fields as $field) {
3206                 $contents = '';
3207                 if(isset($content[$field->field->id])) {
3208                     $contents = $field->export_text_value($content[$field->field->id]);
3209                 }
3210                 $exportdata[$line][] = $contents;
3211             }
3212             if ($tags) {
3213                 $itemtags = \core_tag_tag::get_item_tags_array('mod_data', 'data_records', $record->id);
3214                 $exportdata[$line][] = implode(', ', $itemtags);
3215             }
3216             if ($userdetails) { // Add user details to the export data
3217                 $userdata = get_complete_user_data('id', $record->userid);
3218                 $exportdata[$line][] = fullname($userdata);
3219                 $exportdata[$line][] = $userdata->username;
3220                 $exportdata[$line][] = $userdata->email;
3221             }
3222             if ($time) { // Add time added / modified
3223                 $exportdata[$line][] = userdate($record->timecreated);
3224                 $exportdata[$line][] = userdate($record->timemodified);
3225             }
3226             if ($approval) { // Add approval status
3227                 $exportdata[$line][] = (int) $record->approved;
3228             }
3229         }
3230         $line++;
3231     }
3232     $line--;
3233     return $exportdata;
3236 ////////////////////////////////////////////////////////////////////////////////
3237 // File API                                                                   //
3238 ////////////////////////////////////////////////////////////////////////////////
3240 /**
3241  * Lists all browsable file areas
3242  *
3243  * @package  mod_data
3244  * @category files
3245  * @param stdClass $course course object
3246  * @param stdClass $cm course module object
3247  * @param stdClass $context context object
3248  * @return array
3249  */
3250 function data_get_file_areas($course, $cm, $context) {
3251     return array('content' => get_string('areacontent', 'mod_data'));
3254 /**
3255  * File browsing support for data module.
3256  *
3257  * @param file_browser $browser
3258  * @param array $areas
3259  * @param stdClass $course
3260  * @param cm_info $cm
3261  * @param context $context
3262  * @param string $filearea
3263  * @param int $itemid
3264  * @param string $filepath
3265  * @param string $filename
3266  * @return file_info_stored file_info_stored instance or null if not found
3267  */
3268 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
3269     global $CFG, $DB, $USER;
3271     if ($context->contextlevel != CONTEXT_MODULE) {
3272         return null;
3273     }
3275     if (!isset($areas[$filearea])) {
3276         return null;
3277     }
3279     if (is_null($itemid)) {
3280         require_once($CFG->dirroot.'/mod/data/locallib.php');
3281         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
3282     }
3284     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
3285         return null;
3286     }
3288     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3289         return null;
3290     }
3292     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3293         return null;
3294     }
3296     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3297         return null;
3298     }
3300     //check if approved
3301     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3302         return null;
3303     }
3305     // group access
3306     if ($record->groupid) {
3307         $groupmode = groups_get_activity_groupmode($cm, $course);
3308         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3309             if (!groups_is_member($record->groupid)) {
3310                 return null;
3311             }
3312         }
3313     }
3315     $fieldobj = data_get_field($field, $data, $cm);
3317     $filepath = is_null($filepath) ? '/' : $filepath;
3318     $filename = is_null($filename) ? '.' : $filename;
3319     if (!$fieldobj->file_ok($filepath.$filename)) {
3320         return null;
3321     }
3323     $fs = get_file_storage();
3324     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
3325         return null;
3326     }
3328     // Checks to see if the user can manage files or is the owner.
3329     // TODO MDL-33805 - Do not use userid here and move the capability check above.
3330     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
3331         return null;
3332     }
3334     $urlbase = $CFG->wwwroot.'/pluginfile.php';
3336     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
3339 /**
3340  * Serves the data attachments. Implements needed access control ;-)
3341  *
3342  * @package  mod_data
3343  * @category files
3344  * @param stdClass $course course object
3345  * @param stdClass $cm course module object
3346  * @param stdClass $context context object
3347  * @param string $filearea file area
3348  * @param array $args extra arguments
3349  * @param bool $forcedownload whether or not force download
3350  * @param array $options additional options affecting the file serving
3351  * @return bool false if file not found, does not return if found - justsend the file
3352  */
3353 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
3354     global $CFG, $DB;
3356     if ($context->contextlevel != CONTEXT_MODULE) {
3357         return false;
3358     }
3360     require_course_login($course, true, $cm);
3362     if ($filearea === 'content') {
3363         $contentid = (int)array_shift($args);
3365         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
3366             return false;
3367         }
3369         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3370             return false;
3371         }
3373         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3374             return false;
3375         }
3377         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3378             return false;
3379         }
3381         if ($data->id != $cm->instance) {
3382             // hacker attempt - context does not match the contentid
3383             return false;
3384         }
3386         //check if approved
3387         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3388             return false;
3389         }
3391         // group access
3392         if ($record->groupid) {
3393             $groupmode = groups_get_activity_groupmode($cm, $course);
3394             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3395                 if (!groups_is_member($record->groupid)) {
3396                     return false;
3397                 }
3398             }
3399         }
3401         $fieldobj = data_get_field($field, $data, $cm);
3403         $relativepath = implode('/', $args);
3404         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
3406         if (!$fieldobj->file_ok($relativepath)) {
3407             return false;
3408         }
3410         $fs = get_file_storage();
3411         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3412             return false;
3413         }
3415         // finally send the file
3416         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
3417     }
3419     return false;
3423 function data_extend_navigation($navigation, $course, $module, $cm) {
3424     global $CFG, $OUTPUT, $USER, $DB;
3425     require_once($CFG->dirroot . '/mod/data/locallib.php');
3427     $rid = optional_param('rid', 0, PARAM_INT);
3429     $data = $DB->get_record('data', array('id'=>$cm->instance));
3430     $currentgroup = groups_get_activity_group($cm);
3431     $groupmode = groups_get_activity_groupmode($cm);
3433      $numentries = data_numentries($data);
3434     $canmanageentries = has_capability('mod/data:manageentries', context_module::instance($cm->id));
3436     if ($data->entriesleft = data_get_entries_left_to_add($data, $numentries, $canmanageentries)) {
3437         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3438         $entriesnode->add_class('note');
3439     }
3441     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3442     if (!empty($rid)) {
3443         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3444     } else {
3445         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3446     }
3447     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3450 /**
3451  * Adds module specific settings to the settings block
3452  *
3453  * @param settings_navigation $settings The settings navigation object
3454  * @param navigation_node $datanode The node to add module settings to
3455  */
3456 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3457     global $PAGE, $DB, $CFG, $USER;
3459     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3461     $currentgroup = groups_get_activity_group($PAGE->cm);
3462     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3464     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3465         if (empty($editentry)) { //TODO: undefined
3466             $addstring = get_string('add', 'data');
3467         } else {
3468             $addstring = get_string('editentry', 'data');
3469         }
3470         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3471     }
3473     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3474         // The capability required to Export database records is centrally defined in 'lib.php'
3475         // and should be weaker than those required to edit Templates, Fields and Presets.
3476         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3477     }
3478     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3479         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3480     }
3482     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3483         $currenttab = '';
3484         if ($currenttab == 'list') {
3485             $defaultemplate = 'listtemplate';
3486         } else if ($currenttab == 'add') {
3487             $defaultemplate = 'addtemplate';
3488         } else if ($currenttab == 'asearch') {
3489             $defaultemplate = 'asearchtemplate';
3490         } else {
3491             $defaultemplate = 'singletemplate';
3492         }
3494         $templates = $datanode->add(get_string('templates', 'data'));
3496         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3497         foreach ($templatelist as $template) {
3498             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3499         }
3501         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3502         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3503     }
3505     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3506         require_once("$CFG->libdir/rsslib.php");
3508         $string = get_string('rsstype','forum');
3510         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3511         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3512     }
3515 /**
3516  * Save the database configuration as a preset.
3517  *
3518  * @param stdClass $course The course the database module belongs to.
3519  * @param stdClass $cm The course module record
3520  * @param stdClass $data The database record
3521  * @param string $path
3522  * @return bool
3523  */
3524 function data_presets_save($course, $cm, $data, $path) {
3525     global $USER;
3526     $fs = get_file_storage();
3527     $filerecord = new stdClass;
3528     $filerecord->contextid = DATA_PRESET_CONTEXT;
3529     $filerecord->component = DATA_PRESET_COMPONENT;
3530     $filerecord->filearea = DATA_PRESET_FILEAREA;
3531     $filerecord->itemid = 0;
3532     $filerecord->filepath = '/'.$path.'/';
3533     $filerecord->userid = $USER->id;
3535     $filerecord->filename = 'preset.xml';
3536     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3538     $filerecord->filename = 'singletemplate.html';
3539     $fs->create_file_from_string($filerecord, $data->singletemplate);
3541     $filerecord->filename = 'listtemplateheader.html';
3542     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3544     $filerecord->filename = 'listtemplate.html';
3545     $fs->create_file_from_string($filerecord, $data->listtemplate);
3547     $filerecord->filename = 'listtemplatefooter.html';
3548     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3550     $filerecord->filename = 'addtemplate.html';
3551     $fs->create_file_from_string($filerecord, $data->addtemplate);
3553     $filerecord->filename = 'rsstemplate.html';
3554     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3556     $filerecord->filename = 'rsstitletemplate.html';
3557     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3559     $filerecord->filename = 'csstemplate.css';
3560     $fs->create_file_from_string($filerecord, $data->csstemplate);
3562     $filerecord->filename = 'jstemplate.js';
3563     $fs->create_file_from_string($filerecord, $data->jstemplate);
3565     $filerecord->filename = 'asearchtemplate.html';
3566     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3568     return true;
3571 /**
3572  * Generates the XML for the database module provided
3573  *
3574  * @global moodle_database $DB
3575  * @param stdClass $course The course the database module belongs to.
3576  * @param stdClass $cm The course module record
3577  * @param stdClass $data The database record
3578  * @return string The XML for the preset
3579  */
3580 function data_presets_generate_xml($course, $cm, $data) {
3581     global $DB;
3583     // Assemble "preset.xml":
3584     $presetxmldata = "<preset>\n\n";
3586     // Raw settings are not preprocessed during saving of presets
3587     $raw_settings = array(
3588         'intro',
3589         'comments',
3590         'requiredentries',
3591         'requiredentriestoview',
3592         'maxentries',
3593         'rssarticles',
3594         'approval',
3595         'manageapproved',
3596         'defaultsortdir'
3597     );
3599     $presetxmldata .= "<settings>\n";
3600     // First, settings that do not require any conversion
3601     foreach ($raw_settings as $setting) {
3602         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3603     }
3605     // Now specific settings
3606     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3607         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3608     } else {
3609         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3610     }
3611     $presetxmldata .= "</settings>\n\n";
3612     // Now for the fields. Grab all that are non-empty
3613     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3614     ksort($fields);
3615     if (!empty($fields)) {
3616         foreach ($fields as $field) {
3617             $presetxmldata .= "<field>\n";
3618             foreach ($field as $key => $value) {
3619                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3620                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3621                 }
3622             }
3623             $presetxmldata .= "</field>\n\n";
3624         }
3625     }
3626     $presetxmldata .= '</preset>';
3627     return $presetxmldata;
3630 function data_presets_export($course, $cm, $data, $tostorage=false) {
3631     global $CFG, $DB;
3633     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3634     $exportsubdir = "mod_data/presetexport/$presetname";
3635     make_temp_directory($exportsubdir);
3636     $exportdir = "$CFG->tempdir/$exportsubdir";
3638     // Assemble "preset.xml":
3639     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3641     // After opening a file in write mode, close it asap
3642     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3643     fwrite($presetxmlfile, $presetxmldata);
3644     fclose($presetxmlfile);
3646     // Now write the template files
3647     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3648     fwrite($singletemplate, $data->singletemplate);
3649     fclose($singletemplate);
3651     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3652     fwrite($listtemplateheader, $data->listtemplateheader);
3653     fclose($listtemplateheader);
3655     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3656     fwrite($listtemplate, $data->listtemplate);
3657     fclose($listtemplate);
3659     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3660     fwrite($listtemplatefooter, $data->listtemplatefooter);
3661     fclose($listtemplatefooter);
3663     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3664     fwrite($addtemplate, $data->addtemplate);
3665     fclose($addtemplate);
3667     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3668     fwrite($rsstemplate, $data->rsstemplate);
3669     fclose($rsstemplate);
3671     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3672     fwrite($rsstitletemplate, $data->rsstitletemplate);
3673     fclose($rsstitletemplate);
3675     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3676     fwrite($csstemplate, $data->csstemplate);
3677     fclose($csstemplate);
3679     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3680     fwrite($jstemplate, $data->jstemplate);
3681     fclose($jstemplate);
3683     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3684     fwrite($asearchtemplate, $data->asearchtemplate);
3685     fclose($asearchtemplate);
3687     // Check if all files have been generated
3688     if (! is_directory_a_preset($exportdir)) {
3689         print_error('generateerror', 'data');
3690     }
3692     $filenames = array(
3693         'preset.xml',
3694         'singletemplate.html',
3695         'listtemplateheader.html',
3696         'listtemplate.html',
3697         'listtemplatefooter.html',
3698         'addtemplate.html',
3699         'rsstemplate.html',
3700         'rsstitletemplate.html',
3701         'csstemplate.css',
3702         'jstemplate.js',
3703         'asearchtemplate.html'
3704     );
3706     $filelist = array();
3707     foreach ($filenames as $filename) {
3708         $filelist[$filename] = $exportdir . '/' . $filename;
3709     }
3711     $exportfile = $exportdir.'.zip';
3712     file_exists($exportfile) && unlink($exportfile);
3714     $fp = get_file_packer('application/zip');
3715     $fp->archive_to_pathname($filelist, $exportfile);
3717     foreach ($filelist as $file) {
3718         unlink($file);
3719     }
3720     rmdir($exportdir);
3722     // Return the full path to the exported preset file:
3723     return $exportfile;
3726 /**
3727  * Running addtional permission check on plugin, for example, plugins
3728  * may have switch to turn on/off comments option, this callback will
3729  * affect UI display, not like pluginname_comment_validate only throw
3730  * exceptions.
3731  * Capability check has been done in comment->check_permissions(), we
3732  * don't need to do it again here.
3733  *
3734  * @package  mod_data
3735  * @category comment
3736  *
3737  * @param stdClass $comment_param {
3738  *              context  => context the context object
3739  *              courseid => int course id
3740  *              cm       => stdClass course module object
3741  *              commentarea => string comment area
3742  *              itemid      => int itemid
3743  * }
3744  * @return array
3745  */
3746 function data_comment_permissions($comment_param) {
3747     global $CFG, $DB;
3748     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3749         throw new comment_exception('invalidcommentitemid');
3750     }
3751     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3752         throw new comment_exception('invalidid', 'data');
3753     }
3754     if ($data->comments) {
3755         return array('post'=>true, 'view'=>true);
3756     } else {
3757         return array('post'=>false, 'view'=>false);
3758     }
3761 /**
3762  * Validate comment parameter before perform other comments actions
3763  *
3764  * @package  mod_data
3765  * @category comment
3766  *
3767  * @param stdClass $comment_param {
3768  *              context  => context the context object
3769  *              courseid => int course id
3770  *              cm       => stdClass course module object
3771  *              commentarea => string comment area
3772  *              itemid      => int itemid
3773  * }
3774  * @return boolean
3775  */
3776 function data_comment_validate($comment_param) {
3777     global $DB;
3778     // validate comment area
3779     if ($comment_param->commentarea != 'database_entry') {
3780         throw new comment_exception('invalidcommentarea');
3781     }
3782     // validate itemid
3783     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3784         throw new comment_exception('invalidcommentitemid');
3785     }
3786     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3787         throw new comment_exception('invalidid', 'data');
3788     }
3789     if (!$course = $DB->get_record('course', array('id'=>$data->course))) {
3790         throw new comment_exception('coursemisconf');
3791     }
3792     if (!$cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
3793         throw new comment_exception('invalidcoursemodule');
3794     }
3795     if (!$data->comments) {
3796         throw new comment_exception('commentsoff', 'data');
3797     }
3798     $context = context_module::instance($cm->id);
3800     //check if approved
3801     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3802         throw new comment_exception('notapproved', 'data');
3803     }
3805     // group access
3806     if ($record->groupid) {
3807         $groupmode = groups_get_activity_groupmode($cm, $course);
3808         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3809             if (!groups_is_member($record->groupid)) {
3810                 throw new comment_exception('notmemberofgroup');
3811             }
3812         }
3813     }
3814     // validate context id
3815     if ($context->id != $comment_param->context->id) {
3816         throw new comment_exception('invalidcontext');
3817     }
3818     // validation for comment deletion
3819     if (!empty($comment_param->commentid)) {
3820         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3821             if ($comment->commentarea != 'database_entry') {
3822                 throw new comment_exception('invalidcommentarea');
3823             }
3824             if ($comment->contextid != $comment_param->context->id) {
3825                 throw new comment_exception('invalidcontext');
3826             }
3827             if ($comment->itemid != $comment_param->itemid) {
3828                 throw new comment_exception('invalidcommentitemid');
3829             }
3830         } else {
3831             throw new comment_exception('invalidcommentid');
3832         }
3833     }
3834     return true;
3837 /**
3838  * Return a list of page types
3839  * @param string $pagetype current page type
3840  * @param stdClass $parentcontext Block's parent context
3841  * @param stdClass $currentcontext Current context of block
3842  */
3843 function data_page_type_list($pagetype, $parentcontext, $currentcontext) {
3844     $module_pagetype = array('mod-data-*'=>get_string('page-mod-data-x', 'data'));
3845     return $module_pagetype;
3848 /**
3849  * Get all of the record ids from a database activity.
3850  *
3851  * @param int    $dataid      The dataid of the database module.
3852  * @param object $selectdata  Contains an additional sql statement for the
3853  *                            where clause for group and approval fields.
3854  * @param array  $params      Parameters that coincide with the sql statement.
3855  * @return array $idarray     An array of record ids
3856  */
3857 function data_get_all_recordids($dataid, $selectdata = '', $params = null) {
3858     global $DB;
3859     $initsql = 'SELECT r.id
3860                   FROM {data_records} r
3861                  WHERE r.dataid = :dataid';
3862     if ($selectdata != '') {
3863         $initsql .= $selectdata;
3864         $params = array_merge(array('dataid' => $dataid), $params);
3865     } else {
3866         $params = array('dataid' => $dataid);
3867     }
3868     $initsql .= ' GROUP BY r.id';
3869     $initrecord = $DB->get_recordset_sql($initsql, $params);
3870     $idarray = array();
3871     foreach ($initrecord as $data) {
3872         $idarray[] = $data->id;
3873     }
3874     // Close the record set and free up resources.
3875     $initrecord->close();
3876     return $idarray;
3879 /**
3880  * Get the ids of all the records that match that advanced search criteria
3881  * This goes and loops through each criterion one at a time until it either
3882  * runs out of records or returns a subset of records.
3883  *
3884  * @param array $recordids    An array of record ids.
3885  * @param array $searcharray  Contains information for the advanced search criteria
3886  * @param int $dataid         The data id of the database.
3887  * @return array $recordids   An array of record ids.
3888  */
3889 function data_get_advance_search_ids($recordids, $searcharray, $dataid) {
3890     // Check to see if we have any record IDs.
3891     if (empty($recordids)) {
3892         // Send back an empty search.
3893         return array();
3894     }
3895     $searchcriteria = array_keys($searcharray);
3896     // Loop through and reduce the IDs one search criteria at a time.
3897     foreach ($searchcriteria as $key) {
3898         $recordids = data_get_recordids($key, $searcharray, $dataid, $recordids);
3899         // If we don't have anymore IDs then stop.
3900         if (!$recordids) {
3901             break;
3902         }
3903     }
3904     return $recordids;
3907 /**
3908  * Gets the record IDs given the search criteria
3909  *
3910  * @param string $alias       Record alias.
3911  * @param array $searcharray  Criteria for the search.
3912  * @param int $dataid         Data ID for the database
3913  * @param array $recordids    An array of record IDs.
3914  * @return array $nestarray   An arry of record IDs
3915  */
3916 function data_get_recordids($alias, $searcharray, $dataid, $recordids) {
3917     global $DB;
3918     $searchcriteria = $alias;   // Keep the criteria.
3919     $nestsearch = $searcharray[$alias];
3920     // searching for content outside of mdl_data_content
3921     if ($alias < 0) {
3922         $alias = '';
3923     }
3924     list($insql, $params) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
3925     $nestselect = 'SELECT c' . $alias . '.recordid
3926                      FROM {data_content} c' . $alias . '
3927                INNER JOIN {data_fields} f
3928                        ON f.id = c' . $alias . '.fieldid
3929                INNER JOIN {data_records} r
3930                        ON r.id = c' . $alias . '.recordid
3931                INNER JOIN {user} u
3932                        ON u.id = r.userid ';
3933     $nestwhere = 'WHERE r.dataid = :dataid
3934                     AND c' . $alias .'.recordid ' . $insql . '
3935                     AND ';
3937     $params['dataid'] = $dataid;
3938     if (count($nestsearch->params) != 0) {
3939         $params = array_merge($params, $nestsearch->params);
3940         $nestsql = $nestselect . $nestwhere . $nestsearch->sql;
3941     } else if ($searchcriteria == DATA_TIMEMODIFIED) {
3942         $nestsql = $nestselect . $nestwhere . $nestsearch->field . ' >= :timemodified GROUP BY c' . $alias . '.recordid';
3943         $params['timemodified'] = $nestsearch->data;
3944     } else if ($searchcriteria == DATA_TAGS) {
3945         if (empty($nestsearch->rawtagnames)) {
3946             return [];
3947         }
3948         $i = 0;
3949         $tagwhere = [];
3950         $tagselect = '';
3951         foreach ($nestsearch->rawtagnames as $tagrawname) {
3952             $tagselect .= " INNER JOIN {tag_instance} ti_$i
3953                                     ON ti_$i.component = 'mod_data'
3954                                    AND ti_$i.itemtype = 'data_records'
3955                                    AND ti_$i.itemid = r.id
3956                             INNER JOIN {tag} t_$i
3957                                     ON ti_$i.tagid = t_$i.id ";
3958             $tagwhere[] = " t_$i.rawname = :trawname_$i ";
3959             $params["trawname_$i"] = $tagrawname;
3960             $i++;
3961         }
3962         $nestsql = $nestselect . $tagselect . $nestwhere . implode(' AND ', $tagwhere);
3963     } else {    // First name or last name.
3964         $thing = $DB->sql_like($nestsearch->field, ':search1', false);
3965         $nestsql = $nestselect . $nestwhere . $thing . ' GROUP BY c' . $alias . '.recordid';
3966         $params['search1'] = "%$nestsearch->data%";
3967     }
3968     $nestrecords = $DB->get_recordset_sql($nestsql, $params);
3969     $nestarray = array();
3970     foreach ($nestrecords as $data) {
3971         $nestarray[] = $data->recordid;
3972     }
3973     // Close the record set and free up resources.
3974     $nestrecords->close();
3975     return $nestarray;
3978 /**
3979  * Returns an array with an sql string for advanced searches and the parameters that go with them.
3980  *
3981  * @param int $sort            DATA_*
3982  * @param stdClass $data       Data module object
3983  * @param array $recordids     An array of record IDs.
3984  * @param string $selectdata   Information for the where and select part of the sql statement.
3985  * @param string $sortorder    Additional sort parameters
3986  * @return array sqlselect     sqlselect['sql'] has the sql string, sqlselect['params'] contains an array of parameters.
3987  */
3988 function data_get_advanced_search_sql($sort, $data, $recordids, $selectdata, $sortorder) {
3989     global $DB;
3991     $namefields = user_picture::fields('u');
3992     // Remove the id from the string. This already exists in the sql statement.
3993     $namefields = str_replace('u.id,', '', $namefields);
3995     if ($sort == 0) {
3996         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . '
3997                         FROM {data_content} c,
3998                              {data_records} r,
3999                              {user} u ';
4000         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, u.firstname, u.lastname, ' . $namefields;
4001     } else {
4002         // Sorting through 'Other' criteria
4003         if ($sort <= 0) {
4004             switch ($sort) {
4005                 case DATA_LASTNAME:
4006                     $sortcontentfull = "u.lastname";
4007                     break;
4008                 case DATA_FIRSTNAME:
4009                     $sortcontentfull = "u.firstname";
4010                     break;
4011                 case DATA_APPROVED:
4012                     $sortcontentfull = "r.approved";
4013                     break;
4014                 case DATA_TIMEMODIFIED:
4015                     $sortcontentfull = "r.timemodified";
4016                     break;
4017                 case DATA_TIMEADDED:
4018                 default:
4019                     $sortcontentfull = "r.timecreated";
4020             }
4021         } else {
4022             $sortfield = data_get_field_from_id($sort, $data);
4023             $sortcontent = $DB->sql_compare_text('c.' . $sortfield->get_sort_field());
4024             $sortcontentfull = $sortfield->get_sort_sql($sortcontent);
4025         }
4027         $nestselectsql = 'SELECT r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . ',
4028                                  ' . $sortcontentfull . '
4029                               AS sortorder
4030                             FROM {data_content} c,
4031                                  {data_records} r,
4032                                  {user} u ';
4033         $groupsql = ' GROUP BY r.id, r.approved, r.timecreated, r.timemodified, r.userid, ' . $namefields . ', ' .$sortcontentfull;
4034     }
4036     // Default to a standard Where statement if $selectdata is empty.
4037     if ($selectdata == '') {
4038         $selectdata = 'WHERE c.recordid = r.id
4039                          AND r.dataid = :dataid
4040                          AND r.userid = u.id ';
4041     }
4043     // Find the field we are sorting on
4044     if ($sort > 0 or data_get_field_from_id($sort, $data)) {
4045         $selectdata .= ' AND c.fieldid = :sort';
4046     }
4048     // If there are no record IDs then return an sql statment that will return no rows.
4049     if (count($recordids) != 0) {
4050         list($insql, $inparam) = $DB->get_in_or_equal($recordids, SQL_PARAMS_NAMED);
4051     } else {
4052         list($insql, $inparam) = $DB->get_in_or_equal(array('-1'), SQL_PARAMS_NAMED);
4053     }
4054     $nestfromsql = $selectdata . ' AND c.recordid ' . $insql . $groupsql;
4055     $sqlselect['sql'] = "$nestselectsql $nestfromsql $sortorder";
4056     $sqlselect['params'] = $inparam;
4057     return $sqlselect;
4060 /**
4061  * Checks to see if the user has permission to delete the preset.
4062  * @param stdClass $context  Context object.
4063  * @param stdClass $preset  The preset object that we are checking for deletion.
4064  * @return bool  Returns true if the user can delete, otherwise false.
4065  */
4066 function data_user_can_delete_preset($context, $preset) {
4067     global $USER;
4069     if (has_capability('mod/data:manageuserpresets', $context)) {
4070         return true;
4071     } else {
4072         $candelete = false;
4073         if ($preset->userid == $USER->id) {
4074             $candelete = true;
4075         }
4076         return $candelete;
4077     }
4080 /**
4081  * Delete a record entry.
4082  *
4083  * @param int $recordid The ID for the record to be deleted.
4084  * @param object $data The data object for this activity.
4085  * @param int $courseid ID for the current course (for logging).
4086  * @param int $cmid The course module ID.
4087  * @return bool True if the record deleted, false if not.
4088  */
4089 function data_delete_record($recordid, $data, $courseid, $cmid) {
4090     global $DB, $CFG;
4092     if ($deleterecord = $DB->get_record('data_records', array('id' => $recordid))) {
4093         if ($deleterecord->dataid == $data->id) {
4094             if ($contents = $DB->get_records('data_content', array('recordid' => $deleterecord->id))) {
4095                 foreach ($contents as $content) {
4096                     if ($field = data_get_field_from_id($content->fieldid, $data)) {
4097                         $field->delete_content($content->recordid);
4098                     }
4099                 }
4100                 $DB->delete_records('data_content', array('recordid'=>$deleterecord->id));
4101                 $DB->delete_records('data_records', array('id'=>$deleterecord->id));
4103                 // Delete cached RSS feeds.
4104                 if (!empty($CFG->enablerssfeeds)) {
4105                     require_once($CFG->dirroot.'/mod/data/rsslib.php');
4106                     data_rss_delete_file($data);
4107                 }
4109                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $recordid);
4111                 // Trigger an event for deleting this record.
4112                 $event = \mod_data\event\record_deleted::create(array(
4113                     'objectid' => $deleterecord->id,
4114                     'context' => context_module::instance($cmid),
4115                     'courseid' => $courseid,
4116                     'other' => array(
4117                         'dataid' => $deleterecord->dataid
4118                     )
4119                 ));
4120                 $event->add_record_snapshot('data_records', $deleterecord);
4121                 $event->trigger();
4122                 $course = get_course($courseid);
4123                 $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
4124                 data_update_completion_state($data, $course, $cm);
4126                 return true;
4127             }
4128         }
4129     }
4131     return false;
4134 /**
4135  * Check for required fields, and build a list of fields to be updated in a
4136  * submission.
4137  *
4138  * @param $mod stdClass The current recordid - provided as an optimisation.
4139  * @param $fields array The field data
4140  * @param $datarecord stdClass The submitted data.
4141  * @return stdClass containing:
4142  * * string[] generalnotifications Notifications for the form as a whole.
4143  * * string[] fieldnotifications Notifications for a specific field.
4144  * * bool validated Whether the field was validated successfully.
4145  * * data_field_base[] fields The field objects to be update.
4146  */
4147 function data_process_submission(stdClass $mod, $fields, stdClass $datarecord) {
4148     $result = new stdClass();
4150     // Empty form checking - you can't submit an empty form.
4151     $emptyform = true;
4152     $requiredfieldsfilled = true;
4153     $fieldsvalidated = true;
4155     // Store the notifications.
4156     $result->generalnotifications = array();
4157     $result->fieldnotifications = array();
4159     // Store the instantiated classes as an optimisation when processing the result.
4160     // This prevents the fields being re-initialised when updating.
4161     $result->fields = array();
4163     $submitteddata = array();
4164     foreach ($datarecord as $fieldname => $fieldvalue) {
4165         if (strpos($fieldname, '_')) {
4166             $namearray = explode('_', $fieldname, 3);
4167             $fieldid = $namearray[1];
4168             if (!isset($submitteddata[$fieldid])) {
4169                 $submitteddata[$fieldid] = array();
4170             }
4171             if (count($namearray) === 2) {
4172                 $subfieldid = 0;
4173             } else {
4174                 $subfieldid = $namearray[2];
4175             }
4177             $fielddata = new stdClass();
4178             $fielddata->fieldname = $fieldname;
4179             $fielddata->value = $fieldvalue;
4180             $submitteddata[$fieldid][$subfieldid] = $fielddata;
4181         }
4182     }
4184     // Check all form fields which have the required are filled.
4185     foreach ($fields as $fieldrecord) {
4186         // Check whether the field has any data.
4187         $fieldhascontent = false;
4189         $field = data_get_field($fieldrecord, $mod);
4190         if (isset($submitteddata[$fieldrecord->id])) {
4191             // Field validation check.
4192             if (method_exists($field, 'field_validation')) {
4193                 $errormessage = $field->field_validation($submitteddata[$fieldrecord->id]);
4194                 if ($errormessage) {
4195                     $result->fieldnotifications[$field->field->name][] = $errormessage;
4196                     $fieldsvalidated = false;
4197                 }
4198             }
4199             foreach ($submitteddata[$fieldrecord->id] as $fieldname => $value) {
4200                 if ($field->notemptyfield($value->value, $value->fieldname)) {
4201                     // The field has content and the form is not empty.
4202                     $fieldhascontent = true;
4203                     $emptyform = false;
4204                 }
4205             }
4206         }
4208         // If the field is required, add a notification to that effect.
4209         if ($field->field->required && !$fieldhascontent) {
4210             if (!isset($result->fieldnotifications[$field->field->name])) {
4211                 $result->fieldnotifications[$field->field->name] = array();
4212             }
4213             $result->fieldnotifications[$field->field->name][] = get_string('errormustsupplyvalue', 'data');
4214             $requiredfieldsfilled = false;
4215         }
4217         // Update the field.
4218         if (isset($submitteddata[$fieldrecord->id])) {
4219             foreach ($submitteddata[$fieldrecord->id] as $value) {
4220                 $result->fields[$value->fieldname] = $field;
4221             }
4222         }
4223     }
4225     if ($emptyform) {
4226         // The form is empty.
4227         $result->generalnotifications[] = get_string('emptyaddform', 'data');
4228     }
4230     $result->validated = $requiredfieldsfilled && !$emptyform && $fieldsvalidated;
4232     return $result;
4235 /**
4236  * This standard function will check all instances of this module
4237  * and make sure there are up-to-date events created for each of them.
4238  * If courseid = 0, then every data event in the site is checked, else
4239  * only data events belonging to the course specified are checked.
4240  * This function is used, in its new format, by restore_refresh_events()
4241  *
4242  * @param int $courseid
4243  * @param int|stdClass $instance Data module instance or ID.
4244  * @param int|stdClass $cm Course module object or ID (not used in this module).
4245  * @return bool
4246  */
4247 function data_refresh_events($courseid = 0, $instance = null, $cm = null) {
4248     global $DB, $CFG;
4249     require_once($CFG->dirroot.'/mod/data/locallib.php');
4251     // If we have instance information then we can just update the one event instead of updating all events.
4252     if (isset($instance)) {
4253         if (!is_object($instance)) {
4254             $instance = $DB->get_record('data', array('id' => $instance), '*', MUST_EXIST);
4255         }
4256         data_set_events($instance);
4257         return true;
4258     }
4260     if ($courseid) {
4261         if (! $data = $DB->get_records("data", array("course" => $courseid))) {
4262             return true;
4263         }
4264     } else {
4265         if (! $data = $DB->get_records("data")) {
4266             return true;
4267         }
4268     }
4270     foreach ($data as $datum) {
4271         data_set_events($datum);
4272     }
4273     return true;
4276 /**
4277  * Fetch the configuration for this database activity.
4278  *
4279  * @param   stdClass    $database   The object returned from the database for this instance
4280  * @param   string      $key        The name of the key to retrieve. If none is supplied, then all configuration is returned
4281  * @param   mixed       $default    The default value to use if no value was found for the specified key
4282  * @return  mixed                   The returned value
4283  */
4284 function data_get_config($database, $key = null, $default = null) {
4285     if (!empty($database->config)) {
4286         $config = json_decode($database->config);
4287     } else {
4288         $config = new stdClass();
4289     }
4291     if ($key === null) {
4292         return $config;
4293     }
4295     if (property_exists($config, $key)) {
4296         return $config->$key;
4297     }
4298     return $default;
4301 /**
4302  * Update the configuration for this database activity.
4303  *
4304  * @param   stdClass    $database   The object returned from the database for this instance
4305  * @param   string      $key        The name of the key to set
4306  * @param   mixed       $value      The value to set for the key
4307  */
4308 function data_set_config(&$database, $key, $value) {
4309     // Note: We must pass $database by reference because there may be subsequent calls to update_record and these should
4310     // not overwrite the configuration just set.
4311     global $DB;
4313     $config = data_get_config($database);
4315     if (!isset($config->$key) || $config->$key !== $value) {
4316         $config->$key = $value;
4317         $database->config = json_encode($config);
4318         $DB->set_field('data', 'config', $database->config, ['id' => $database->id]);
4319     }
4321 /**
4322  * Sets the automatic completion state for this data