Merge branch 'MDL-59470' of https://github.com/Chocolate-lightning/moodle
[moodle.git] / mod / data / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package   mod_data
20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 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 = new stdClass();
1205         if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1206             $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1207         } else {
1208             $result->info = get_string('grade') . ': ' . get_string('hidden', 'grades');
1209         }
1211         //datesubmitted == time created. dategraded == time modified or time overridden
1212         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1213         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1214         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1215             $result->time = $grade->dategraded;
1216         } else {
1217             $result->time = $grade->datesubmitted;
1218         }
1220         return $result;
1221     }
1222     return NULL;
1225 /**
1226  * Prints all the records uploaded by this user
1227  *
1228  * @global object
1229  * @param object $course
1230  * @param object $user
1231  * @param object $mod
1232  * @param object $data
1233  */
1234 function data_user_complete($course, $user, $mod, $data) {
1235     global $DB, $CFG, $OUTPUT;
1236     require_once("$CFG->libdir/gradelib.php");
1238     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
1239     if (!empty($grades->items[0]->grades)) {
1240         $grade = reset($grades->items[0]->grades);
1241         if (!$grade->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
1242             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1243             if ($grade->str_feedback) {
1244                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1245             }
1246         } else {
1247             echo $OUTPUT->container(get_string('grade') . ': ' . get_string('hidden', 'grades'));
1248         }
1249     }
1251     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1252         data_print_template('singletemplate', $records, $data);
1253     }
1256 /**
1257  * Return grade for given user or all users.
1258  *
1259  * @global object
1260  * @param object $data
1261  * @param int $userid optional user id, 0 means all users
1262  * @return array array of grades, false if none
1263  */
1264 function data_get_user_grades($data, $userid=0) {
1265     global $CFG;
1267     require_once($CFG->dirroot.'/rating/lib.php');
1269     $ratingoptions = new stdClass;
1270     $ratingoptions->component = 'mod_data';
1271     $ratingoptions->ratingarea = 'entry';
1272     $ratingoptions->modulename = 'data';
1273     $ratingoptions->moduleid   = $data->id;
1275     $ratingoptions->userid = $userid;
1276     $ratingoptions->aggregationmethod = $data->assessed;
1277     $ratingoptions->scaleid = $data->scale;
1278     $ratingoptions->itemtable = 'data_records';
1279     $ratingoptions->itemtableusercolumn = 'userid';
1281     $rm = new rating_manager();
1282     return $rm->get_user_grades($ratingoptions);
1285 /**
1286  * Update activity grades
1287  *
1288  * @category grade
1289  * @param object $data
1290  * @param int $userid specific user only, 0 means all
1291  * @param bool $nullifnone
1292  */
1293 function data_update_grades($data, $userid=0, $nullifnone=true) {
1294     global $CFG, $DB;
1295     require_once($CFG->libdir.'/gradelib.php');
1297     if (!$data->assessed) {
1298         data_grade_item_update($data);
1300     } else if ($grades = data_get_user_grades($data, $userid)) {
1301         data_grade_item_update($data, $grades);
1303     } else if ($userid and $nullifnone) {
1304         $grade = new stdClass();
1305         $grade->userid   = $userid;
1306         $grade->rawgrade = NULL;
1307         data_grade_item_update($data, $grade);
1309     } else {
1310         data_grade_item_update($data);
1311     }
1314 /**
1315  * Update/create grade item for given data
1316  *
1317  * @category grade
1318  * @param stdClass $data A database instance with extra cmidnumber property
1319  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1320  * @return object grade_item
1321  */
1322 function data_grade_item_update($data, $grades=NULL) {
1323     global $CFG;
1324     require_once($CFG->libdir.'/gradelib.php');
1326     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1328     if (!$data->assessed or $data->scale == 0) {
1329         $params['gradetype'] = GRADE_TYPE_NONE;
1331     } else if ($data->scale > 0) {
1332         $params['gradetype'] = GRADE_TYPE_VALUE;
1333         $params['grademax']  = $data->scale;
1334         $params['grademin']  = 0;
1336     } else if ($data->scale < 0) {
1337         $params['gradetype'] = GRADE_TYPE_SCALE;
1338         $params['scaleid']   = -$data->scale;
1339     }
1341     if ($grades  === 'reset') {
1342         $params['reset'] = true;
1343         $grades = NULL;
1344     }
1346     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1349 /**
1350  * Delete grade item for given data
1351  *
1352  * @category grade
1353  * @param object $data object
1354  * @return object grade_item
1355  */
1356 function data_grade_item_delete($data) {
1357     global $CFG;
1358     require_once($CFG->libdir.'/gradelib.php');
1360     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1363 // junk functions
1364 /**
1365  * takes a list of records, the current data, a search string,
1366  * and mode to display prints the translated template
1367  *
1368  * @global object
1369  * @global object
1370  * @param string $template
1371  * @param array $records
1372  * @param object $data
1373  * @param string $search
1374  * @param int $page
1375  * @param bool $return
1376  * @param object $jumpurl a moodle_url by which to jump back to the record list (can be null)
1377  * @return mixed
1378  */
1379 function data_print_template($template, $records, $data, $search='', $page=0, $return=false, moodle_url $jumpurl=null) {
1380     global $CFG, $DB, $OUTPUT;
1382     $cm = get_coursemodule_from_instance('data', $data->id);
1383     $context = context_module::instance($cm->id);
1385     static $fields = array();
1386     static $dataid = null;
1388     if (empty($dataid)) {
1389         $dataid = $data->id;
1390     } else if ($dataid != $data->id) {
1391         $fields = array();
1392     }
1394     if (empty($fields)) {
1395         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1396         foreach ($fieldrecords as $fieldrecord) {
1397             $fields[]= data_get_field($fieldrecord, $data);
1398         }
1399     }
1401     if (empty($records)) {
1402         return;
1403     }
1405     if (!$jumpurl) {
1406         $jumpurl = new moodle_url('/mod/data/view.php', array('d' => $data->id));
1407     }
1408     $jumpurl = new moodle_url($jumpurl, array('page' => $page, 'sesskey' => sesskey()));
1410     foreach ($records as $record) {   // Might be just one for the single template
1412     // Replacing tags
1413         $patterns = array();
1414         $replacement = array();
1416     // Then we generate strings to replace for normal tags
1417         foreach ($fields as $field) {
1418             $patterns[]='[['.$field->field->name.']]';
1419             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1420         }
1422         $canmanageentries = has_capability('mod/data:manageentries', $context);
1424     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1425         $patterns[]='##edit##';
1426         $patterns[]='##delete##';
1427         if (data_user_can_manage_entry($record, $data, $context)) {
1428             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1429                              .$data->id.'&amp;rid='.$record->id.'&amp;sesskey='.sesskey().'">' .
1430                              $OUTPUT->pix_icon('t/edit', get_string('edit')) . '</a>';
1431             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1432                              .$data->id.'&amp;delete='.$record->id.'&amp;sesskey='.sesskey().'">' .
1433                              $OUTPUT->pix_icon('t/delete', get_string('delete')) . '</a>';
1434         } else {
1435             $replacement[] = '';
1436             $replacement[] = '';
1437         }
1439         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1440         if ($search) {
1441             $moreurl .= '&amp;filter=1';
1442         }
1443         $patterns[]='##more##';
1444         $replacement[] = '<a href="'.$moreurl.'">' . $OUTPUT->pix_icon('t/preview', get_string('more', 'data')) . '</a>';
1446         $patterns[]='##moreurl##';
1447         $replacement[] = $moreurl;
1449         $patterns[]='##delcheck##';
1450         if ($canmanageentries) {
1451             $replacement[] = html_writer::checkbox('delcheck[]', $record->id, false, '', array('class' => 'recordcheckbox'));
1452         } else {
1453             $replacement[] = '';
1454         }
1456         $patterns[]='##user##';
1457         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1458                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1460         $patterns[] = '##userpicture##';
1461         $ruser = user_picture::unalias($record, null, 'userid');
1462         // If the record didn't come with user data, retrieve the user from database.
1463         if (!isset($ruser->picture)) {
1464             $ruser = core_user::get_user($record->userid);
1465         }
1466         $replacement[] = $OUTPUT->user_picture($ruser, array('courseid' => $data->course));
1468         $patterns[]='##export##';
1470         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1471             && ((has_capability('mod/data:exportentry', $context)
1472                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1473             require_once($CFG->libdir . '/portfoliolib.php');
1474             $button = new portfolio_add_button();
1475             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), 'mod_data');
1476             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1477             $button->set_formats($formats);
1478             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1479         } else {
1480             $replacement[] = '';
1481         }
1483         $patterns[] = '##timeadded##';
1484         $replacement[] = userdate($record->timecreated);
1486         $patterns[] = '##timemodified##';
1487         $replacement [] = userdate($record->timemodified);
1489         $patterns[]='##approve##';
1490         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)) {
1491             $approveurl = new moodle_url($jumpurl, array('approve' => $record->id));
1492             $approveicon = new pix_icon('t/approve', get_string('approve', 'data'), '', array('class' => 'iconsmall'));
1493             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($approveurl, $approveicon),
1494                     array('class' => 'approve'));
1495         } else {
1496             $replacement[] = '';
1497         }
1499         $patterns[]='##disapprove##';
1500         if (has_capability('mod/data:approve', $context) && ($data->approval) && ($record->approved)) {
1501             $disapproveurl = new moodle_url($jumpurl, array('disapprove' => $record->id));
1502             $disapproveicon = new pix_icon('t/block', get_string('disapprove', 'data'), '', array('class' => 'iconsmall'));
1503             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($disapproveurl, $disapproveicon),
1504                     array('class' => 'disapprove'));
1505         } else {
1506             $replacement[] = '';
1507         }
1509         $patterns[] = '##approvalstatus##';
1510         $patterns[] = '##approvalstatusclass##';
1511         if (!$data->approval) {
1512             $replacement[] = '';
1513             $replacement[] = '';
1514         } else if ($record->approved) {
1515             $replacement[] = get_string('approved', 'data');
1516             $replacement[] = 'approved';
1517         } else {
1518             $replacement[] = get_string('notapproved', 'data');
1519             $replacement[] = 'notapproved';
1520         }
1522         $patterns[]='##comments##';
1523         if (($template == 'listtemplate') && ($data->comments)) {
1525             if (!empty($CFG->usecomments)) {
1526                 require_once($CFG->dirroot  . '/comment/lib.php');
1527                 list($context, $course, $cm) = get_context_info_array($context->id);
1528                 $cmt = new stdClass();
1529                 $cmt->context = $context;
1530                 $cmt->course  = $course;
1531                 $cmt->cm      = $cm;
1532                 $cmt->area    = 'database_entry';
1533                 $cmt->itemid  = $record->id;
1534                 $cmt->showcount = true;
1535                 $cmt->component = 'mod_data';
1536                 $comment = new comment($cmt);
1537                 $replacement[] = $comment->output(true);
1538             }
1539         } else {
1540             $replacement[] = '';
1541         }
1543         if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1544             $patterns[] = "##tags##";
1545             $replacement[] = $OUTPUT->tag_list(
1546                 core_tag_tag::get_item_tags('mod_data', 'data_records', $record->id), '', 'data-tags');
1547         }
1549         // actual replacement of the tags
1550         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1552         // no more html formatting and filtering - see MDL-6635
1553         if ($return) {
1554             return $newtext;
1555         } else {
1556             echo $newtext;
1558             // hack alert - return is always false in singletemplate anyway ;-)
1559             /**********************************
1560              *    Printing Ratings Form       *
1561              *********************************/
1562             if ($template == 'singletemplate') {    //prints ratings options
1563                 data_print_ratings($data, $record);
1564             }
1566             /**********************************
1567              *    Printing Comments Form       *
1568              *********************************/
1569             if (($template == 'singletemplate') && ($data->comments)) {
1570                 if (!empty($CFG->usecomments)) {
1571                     require_once($CFG->dirroot . '/comment/lib.php');
1572                     list($context, $course, $cm) = get_context_info_array($context->id);
1573                     $cmt = new stdClass();
1574                     $cmt->context = $context;
1575                     $cmt->course  = $course;
1576                     $cmt->cm      = $cm;
1577                     $cmt->area    = 'database_entry';
1578                     $cmt->itemid  = $record->id;
1579                     $cmt->showcount = true;
1580                     $cmt->component = 'mod_data';
1581                     $comment = new comment($cmt);
1582                     $comment->output(false);
1583                 }
1584             }
1585         }
1586     }
1589 /**
1590  * Return rating related permissions
1591  *
1592  * @param string $contextid the context id
1593  * @param string $component the component to get rating permissions for
1594  * @param string $ratingarea the rating area to get permissions for
1595  * @return array an associative array of the user's rating permissions
1596  */
1597 function data_rating_permissions($contextid, $component, $ratingarea) {
1598     $context = context::instance_by_id($contextid, MUST_EXIST);
1599     if ($component != 'mod_data' || $ratingarea != 'entry') {
1600         return null;
1601     }
1602     return array(
1603         'view'    => has_capability('mod/data:viewrating',$context),
1604         'viewany' => has_capability('mod/data:viewanyrating',$context),
1605         'viewall' => has_capability('mod/data:viewallratings',$context),
1606         'rate'    => has_capability('mod/data:rate',$context)
1607     );
1610 /**
1611  * Validates a submitted rating
1612  * @param array $params submitted data
1613  *            context => object the context in which the rated items exists [required]
1614  *            itemid => int the ID of the object being rated
1615  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1616  *            rating => int the submitted rating
1617  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1618  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1619  * @return boolean true if the rating is valid. Will throw rating_exception if not
1620  */
1621 function data_rating_validate($params) {
1622     global $DB, $USER;
1624     // Check the component is mod_data
1625     if ($params['component'] != 'mod_data') {
1626         throw new rating_exception('invalidcomponent');
1627     }
1629     // Check the ratingarea is entry (the only rating area in data module)
1630     if ($params['ratingarea'] != 'entry') {
1631         throw new rating_exception('invalidratingarea');
1632     }
1634     // Check the rateduserid is not the current user .. you can't rate your own entries
1635     if ($params['rateduserid'] == $USER->id) {
1636         throw new rating_exception('nopermissiontorate');
1637     }
1639     $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
1640                   FROM {data_records} r
1641                   JOIN {data} d ON r.dataid = d.id
1642                  WHERE r.id = :itemid";
1643     $dataparams = array('itemid'=>$params['itemid']);
1644     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1645         //item doesn't exist
1646         throw new rating_exception('invaliditemid');
1647     }
1649     if ($info->scale != $params['scaleid']) {
1650         //the scale being submitted doesnt match the one in the database
1651         throw new rating_exception('invalidscaleid');
1652     }
1654     //check that the submitted rating is valid for the scale
1656     // lower limit
1657     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1658         throw new rating_exception('invalidnum');
1659     }
1661     // upper limit
1662     if ($info->scale < 0) {
1663         //its a custom scale
1664         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1665         if ($scalerecord) {
1666             $scalearray = explode(',', $scalerecord->scale);
1667             if ($params['rating'] > count($scalearray)) {
1668                 throw new rating_exception('invalidnum');
1669             }
1670         } else {
1671             throw new rating_exception('invalidscaleid');
1672         }
1673     } else if ($params['rating'] > $info->scale) {
1674         //if its numeric and submitted rating is above maximum
1675         throw new rating_exception('invalidnum');
1676     }
1678     if ($info->approval && !$info->approved) {
1679         //database requires approval but this item isnt approved
1680         throw new rating_exception('nopermissiontorate');
1681     }
1683     // check the item we're rating was created in the assessable time window
1684     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1685         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1686             throw new rating_exception('notavailable');
1687         }
1688     }
1690     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1691     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1692     $context = context_module::instance($cm->id);
1694     // if the supplied context doesnt match the item's context
1695     if ($context->id != $params['context']->id) {
1696         throw new rating_exception('invalidcontext');
1697     }
1699     // Make sure groups allow this user to see the item they're rating
1700     $groupid = $info->groupid;
1701     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1702         if (!groups_group_exists($groupid)) { // Can't find group
1703             throw new rating_exception('cannotfindgroup');//something is wrong
1704         }
1706         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1707             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1708             throw new rating_exception('notmemberofgroup');
1709         }
1710     }
1712     return true;
1715 /**
1716  * Can the current user see ratings for a given itemid?
1717  *
1718  * @param array $params submitted data
1719  *            contextid => int contextid [required]
1720  *            component => The component for this module - should always be mod_data [required]
1721  *            ratingarea => object the context in which the rated items exists [required]
1722  *            itemid => int the ID of the object being rated [required]
1723  *            scaleid => int scale id [optional]
1724  * @return bool
1725  * @throws coding_exception
1726  * @throws rating_exception
1727  */
1728 function mod_data_rating_can_see_item_ratings($params) {
1729     global $DB;
1731     // Check the component is mod_data.
1732     if (!isset($params['component']) || $params['component'] != 'mod_data') {
1733         throw new rating_exception('invalidcomponent');
1734     }
1736     // Check the ratingarea is entry (the only rating area in data).
1737     if (!isset($params['ratingarea']) || $params['ratingarea'] != 'entry') {
1738         throw new rating_exception('invalidratingarea');
1739     }
1741     if (!isset($params['itemid'])) {
1742         throw new rating_exception('invaliditemid');
1743     }
1745     $datasql = "SELECT d.id as dataid, d.course, r.groupid
1746                   FROM {data_records} r
1747                   JOIN {data} d ON r.dataid = d.id
1748                  WHERE r.id = :itemid";
1749     $dataparams = array('itemid' => $params['itemid']);
1750     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1751         // Item doesn't exist.
1752         throw new rating_exception('invaliditemid');
1753     }
1755     // User can see ratings of all participants.
1756     if ($info->groupid == 0) {
1757         return true;
1758     }
1760     $course = $DB->get_record('course', array('id' => $info->course), '*', MUST_EXIST);
1761     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1763     // Make sure groups allow this user to see the item they're rating.
1764     return groups_group_visible($info->groupid, $course, $cm);
1768 /**
1769  * function that takes in the current data, number of items per page,
1770  * a search string and prints a preference box in view.php
1771  *
1772  * This preference box prints a searchable advanced search template if
1773  *     a) A template is defined
1774  *  b) The advanced search checkbox is checked.
1775  *
1776  * @global object
1777  * @global object
1778  * @param object $data
1779  * @param int $perpage
1780  * @param string $search
1781  * @param string $sort
1782  * @param string $order
1783  * @param array $search_array
1784  * @param int $advanced
1785  * @param string $mode
1786  * @return void
1787  */
1788 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1789     global $CFG, $DB, $PAGE, $OUTPUT;
1791     $cm = get_coursemodule_from_instance('data', $data->id);
1792     $context = context_module::instance($cm->id);
1793     echo '<br /><div class="datapreferences">';
1794     echo '<form id="options" action="view.php" method="get">';
1795     echo '<div>';
1796     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1797     if ($mode =='asearch') {
1798         $advanced = 1;
1799         echo '<input type="hidden" name="mode" value="list" />';
1800     }
1801     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1802     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1803                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1804     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id' => 'pref_perpage', 'class' => 'custom-select'));
1806     if ($advanced) {
1807         $regsearchclass = 'search_none';
1808         $advancedsearchclass = 'search_inline';
1809     } else {
1810         $regsearchclass = 'search_inline';
1811         $advancedsearchclass = 'search_none';
1812     }
1813     echo '<div id="reg_search" class="' . $regsearchclass . ' form-inline" >&nbsp;&nbsp;&nbsp;';
1814     echo '<label for="pref_search">' . get_string('search') . '</label> <input type="text" ' .
1815          'class="form-control" size="16" name="search" id= "pref_search" value="' . s($search) . '" /></div>';
1816     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1817     // foreach field, print the option
1818     echo '<select name="sort" id="pref_sortby" class="custom-select mr-1">';
1819     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1820         echo '<optgroup label="'.get_string('fields', 'data').'">';
1821         foreach ($fields as $field) {
1822             if ($field->id == $sort) {
1823                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1824             } else {
1825                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1826             }
1827         }
1828         echo '</optgroup>';
1829     }
1830     $options = array();
1831     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1832     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1833     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1834     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1835     if ($data->approval and has_capability('mod/data:approve', $context)) {
1836         $options[DATA_APPROVED] = get_string('approved', 'data');
1837     }
1838     echo '<optgroup label="'.get_string('other', 'data').'">';
1839     foreach ($options as $key => $name) {
1840         if ($key == $sort) {
1841             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1842         } else {
1843             echo '<option value="'.$key.'">'.$name.'</option>';
1844         }
1845     }
1846     echo '</optgroup>';
1847     echo '</select>';
1848     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1849     echo '<select id="pref_order" name="order" class="custom-select mr-1">';
1850     if ($order == 'ASC') {
1851         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1852     } else {
1853         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1854     }
1855     if ($order == 'DESC') {
1856         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1857     } else {
1858         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1859     }
1860     echo '</select>';
1862     if ($advanced) {
1863         $checked = ' checked="checked" ';
1864     }
1865     else {
1866         $checked = '';
1867     }
1868     $PAGE->requires->js('/mod/data/data.js');
1869     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1870     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1871     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" ' . $checked . ' ' .
1872          'onchange="showHideAdvSearch(this.checked);" class="mx-1" />' .
1873          '<label for="advancedcheckbox">' . get_string('advancedsearch', 'data') . '</label>';
1874     echo '&nbsp;<input type="submit" class="btn btn-secondary" value="' . get_string('savesettings', 'data') . '" />';
1876     echo '<br />';
1877     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1878     echo '<table class="boxaligncenter">';
1880     // print ASC or DESC
1881     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1882     $i = 0;
1884     // Determine if we are printing all fields for advanced search, or the template for advanced search
1885     // If a template is not defined, use the deafault template and display all fields.
1886     if(empty($data->asearchtemplate)) {
1887         data_generate_default_template($data, 'asearchtemplate');
1888     }
1890     static $fields = array();
1891     static $dataid = null;
1893     if (empty($dataid)) {
1894         $dataid = $data->id;
1895     } else if ($dataid != $data->id) {
1896         $fields = array();
1897     }
1899     if (empty($fields)) {
1900         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1901         foreach ($fieldrecords as $fieldrecord) {
1902             $fields[]= data_get_field($fieldrecord, $data);
1903         }
1904     }
1906     // Replacing tags
1907     $patterns = array();
1908     $replacement = array();
1910     // Then we generate strings to replace for normal tags
1911     foreach ($fields as $field) {
1912         $fieldname = $field->field->name;
1913         $fieldname = preg_quote($fieldname, '/');
1914         $patterns[] = "/\[\[$fieldname\]\]/i";
1915         $searchfield = data_get_field_from_id($field->field->id, $data);
1916         if (!empty($search_array[$field->field->id]->data)) {
1917             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1918         } else {
1919             $replacement[] = $searchfield->display_search_field();
1920         }
1921     }
1922     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1923     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1924     $patterns[]    = '/##firstname##/';
1925     $replacement[] = '<label class="accesshide" for="u_fn">' . get_string('authorfirstname', 'data') . '</label>' .
1926                      '<input type="text" class="form-control" size="16" id="u_fn" name="u_fn" value="' . s($fn) . '" />';
1927     $patterns[]    = '/##lastname##/';
1928     $replacement[] = '<label class="accesshide" for="u_ln">' . get_string('authorlastname', 'data') . '</label>' .
1929                      '<input type="text" class="form-control" size="16" id="u_ln" name="u_ln" value="' . s($ln) . '" />';
1931     if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1932         $patterns[] = "/##tags##/";
1933         $selectedtags = isset($search_array[DATA_TAGS]->rawtagnames) ? $search_array[DATA_TAGS]->rawtagnames : [];
1934         $replacement[] = data_generate_tag_form(false, $selectedtags);
1935     }
1937     // actual replacement of the tags
1939     $options = new stdClass();
1940     $options->para=false;
1941     $options->noclean=true;
1942     echo '<tr><td>';
1943     echo preg_replace($patterns, $replacement, format_text($data->asearchtemplate, FORMAT_HTML, $options));
1944     echo '</td></tr>';
1946     echo '<tr><td colspan="4"><br/>' .
1947          '<input type="submit" class="btn btn-primary mr-1" value="' . get_string('savesettings', 'data') . '" />' .
1948          '<input type="submit" class="btn btn-secondary" name="resetadv" value="' . get_string('resetsettings', 'data') . '" />' .
1949          '</td></tr>';
1950     echo '</table>';
1951     echo '</div>';
1952     echo '</div>';
1953     echo '</form>';
1954     echo '</div>';
1957 /**
1958  * @global object
1959  * @global object
1960  * @param object $data
1961  * @param object $record
1962  * @return void Output echo'd
1963  */
1964 function data_print_ratings($data, $record) {
1965     global $OUTPUT;
1966     if (!empty($record->rating)){
1967         echo $OUTPUT->render($record->rating);
1968     }
1971 /**
1972  * List the actions that correspond to a view of this module.
1973  * This is used by the participation report.
1974  *
1975  * Note: This is not used by new logging system. Event with
1976  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1977  *       be considered as view action.
1978  *
1979  * @return array
1980  */
1981 function data_get_view_actions() {
1982     return array('view');
1985 /**
1986  * List the actions that correspond to a post of this module.
1987  * This is used by the participation report.
1988  *
1989  * Note: This is not used by new logging system. Event with
1990  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1991  *       will be considered as post action.
1992  *
1993  * @return array
1994  */
1995 function data_get_post_actions() {
1996     return array('add','update','record delete');
1999 /**
2000  * @param string $name
2001  * @param int $dataid
2002  * @param int $fieldid
2003  * @return bool
2004  */
2005 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
2006     global $DB;
2008     if (!is_numeric($name)) {
2009         $like = $DB->sql_like('df.name', ':name', false);
2010     } else {
2011         $like = "df.name = :name";
2012     }
2013     $params = array('name'=>$name);
2014     if ($fieldid) {
2015         $params['dataid']   = $dataid;
2016         $params['fieldid1'] = $fieldid;
2017         $params['fieldid2'] = $fieldid;
2018         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2019                                         WHERE $like AND df.dataid = :dataid
2020                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
2021     } else {
2022         $params['dataid']   = $dataid;
2023         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2024                                         WHERE $like AND df.dataid = :dataid", $params);
2025     }
2028 /**
2029  * @param array $fieldinput
2030  */
2031 function data_convert_arrays_to_strings(&$fieldinput) {
2032     foreach ($fieldinput as $key => $val) {
2033         if (is_array($val)) {
2034             $str = '';
2035             foreach ($val as $inner) {
2036                 $str .= $inner . ',';
2037             }
2038             $str = substr($str, 0, -1);
2040             $fieldinput->$key = $str;
2041         }
2042     }
2046 /**
2047  * Converts a database (module instance) to use the Roles System
2048  *
2049  * @global object
2050  * @global object
2051  * @uses CONTEXT_MODULE
2052  * @uses CAP_PREVENT
2053  * @uses CAP_ALLOW
2054  * @param object $data a data object with the same attributes as a record
2055  *                     from the data database table
2056  * @param int $datamodid the id of the data module, from the modules table
2057  * @param array $teacherroles array of roles that have archetype teacher
2058  * @param array $studentroles array of roles that have archetype student
2059  * @param array $guestroles array of roles that have archetype guest
2060  * @param int $cmid the course_module id for this data instance
2061  * @return boolean data module was converted or not
2062  */
2063 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
2064     global $CFG, $DB, $OUTPUT;
2066     if (!isset($data->participants) && !isset($data->assesspublic)
2067             && !isset($data->groupmode)) {
2068         // We assume that this database has already been converted to use the
2069         // Roles System. above fields get dropped the data module has been
2070         // upgraded to use Roles.
2071         return false;
2072     }
2074     if (empty($cmid)) {
2075         // We were not given the course_module id. Try to find it.
2076         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
2077             echo $OUTPUT->notification('Could not get the course module for the data');
2078             return false;
2079         } else {
2080             $cmid = $cm->id;
2081         }
2082     }
2083     $context = context_module::instance($cmid);
2086     // $data->participants:
2087     // 1 - Only teachers can add entries
2088     // 3 - Teachers and students can add entries
2089     switch ($data->participants) {
2090         case 1:
2091             foreach ($studentroles as $studentrole) {
2092                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
2093             }
2094             foreach ($teacherroles as $teacherrole) {
2095                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2096             }
2097             break;
2098         case 3:
2099             foreach ($studentroles as $studentrole) {
2100                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
2101             }
2102             foreach ($teacherroles as $teacherrole) {
2103                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2104             }
2105             break;
2106     }
2108     // $data->assessed:
2109     // 2 - Only teachers can rate posts
2110     // 1 - Everyone can rate posts
2111     // 0 - No one can rate posts
2112     switch ($data->assessed) {
2113         case 0:
2114             foreach ($studentroles as $studentrole) {
2115                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2116             }
2117             foreach ($teacherroles as $teacherrole) {
2118                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
2119             }
2120             break;
2121         case 1:
2122             foreach ($studentroles as $studentrole) {
2123                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
2124             }
2125             foreach ($teacherroles as $teacherrole) {
2126                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2127             }
2128             break;
2129         case 2:
2130             foreach ($studentroles as $studentrole) {
2131                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2132             }
2133             foreach ($teacherroles as $teacherrole) {
2134                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2135             }
2136             break;
2137     }
2139     // $data->assesspublic:
2140     // 0 - Students can only see their own ratings
2141     // 1 - Students can see everyone's ratings
2142     switch ($data->assesspublic) {
2143         case 0:
2144             foreach ($studentroles as $studentrole) {
2145                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
2146             }
2147             foreach ($teacherroles as $teacherrole) {
2148                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2149             }
2150             break;
2151         case 1:
2152             foreach ($studentroles as $studentrole) {
2153                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
2154             }
2155             foreach ($teacherroles as $teacherrole) {
2156                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2157             }
2158             break;
2159     }
2161     if (empty($cm)) {
2162         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
2163     }
2165     switch ($cm->groupmode) {
2166         case NOGROUPS:
2167             break;
2168         case SEPARATEGROUPS:
2169             foreach ($studentroles as $studentrole) {
2170                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
2171             }
2172             foreach ($teacherroles as $teacherrole) {
2173                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2174             }
2175             break;
2176         case VISIBLEGROUPS:
2177             foreach ($studentroles as $studentrole) {
2178                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
2179             }
2180             foreach ($teacherroles as $teacherrole) {
2181                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2182             }
2183             break;
2184     }
2185     return true;
2188 /**
2189  * Returns the best name to show for a preset
2190  *
2191  * @param string $shortname
2192  * @param  string $path
2193  * @return string
2194  */
2195 function data_preset_name($shortname, $path) {
2197     // We are looking inside the preset itself as a first choice, but also in normal data directory
2198     $string = get_string('modulename', 'datapreset_'.$shortname);
2200     if (substr($string, 0, 1) == '[') {
2201         return $shortname;
2202     } else {
2203         return $string;
2204     }
2207 /**
2208  * Returns an array of all the available presets.
2209  *
2210  * @return array
2211  */
2212 function data_get_available_presets($context) {
2213     global $CFG, $USER;
2215     $presets = array();
2217     // First load the ratings sub plugins that exist within the modules preset dir
2218     if ($dirs = core_component::get_plugin_list('datapreset')) {
2219         foreach ($dirs as $dir=>$fulldir) {
2220             if (is_directory_a_preset($fulldir)) {
2221                 $preset = new stdClass();
2222                 $preset->path = $fulldir;
2223                 $preset->userid = 0;
2224                 $preset->shortname = $dir;
2225                 $preset->name = data_preset_name($dir, $fulldir);
2226                 if (file_exists($fulldir.'/screenshot.jpg')) {
2227                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
2228                 } else if (file_exists($fulldir.'/screenshot.png')) {
2229                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
2230                 } else if (file_exists($fulldir.'/screenshot.gif')) {
2231                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
2232                 }
2233                 $presets[] = $preset;
2234             }
2235         }
2236     }
2237     // Now add to that the site presets that people have saved
2238     $presets = data_get_available_site_presets($context, $presets);
2239     return $presets;
2242 /**
2243  * Gets an array of all of the presets that users have saved to the site.
2244  *
2245  * @param stdClass $context The context that we are looking from.
2246  * @param array $presets
2247  * @return array An array of presets
2248  */
2249 function data_get_available_site_presets($context, array $presets=array()) {
2250     global $USER;
2252     $fs = get_file_storage();
2253     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2254     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
2255     if (empty($files)) {
2256         return $presets;
2257     }
2258     foreach ($files as $file) {
2259         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
2260             continue;
2261         }
2262         $preset = new stdClass;
2263         $preset->path = $file->get_filepath();
2264         $preset->name = trim($preset->path, '/');
2265         $preset->shortname = $preset->name;
2266         $preset->userid = $file->get_userid();
2267         $preset->id = $file->get_id();
2268         $preset->storedfile = $file;
2269         $presets[] = $preset;
2270     }
2271     return $presets;
2274 /**
2275  * Deletes a saved preset.
2276  *
2277  * @param string $name
2278  * @return bool
2279  */
2280 function data_delete_site_preset($name) {
2281     $fs = get_file_storage();
2283     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
2284     if (!empty($files)) {
2285         foreach ($files as $file) {
2286             $file->delete();
2287         }
2288     }
2290     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
2291     if (!empty($dir)) {
2292         $dir->delete();
2293     }
2294     return true;
2297 /**
2298  * Prints the heads for a page
2299  *
2300  * @param stdClass $course
2301  * @param stdClass $cm
2302  * @param stdClass $data
2303  * @param string $currenttab
2304  */
2305 function data_print_header($course, $cm, $data, $currenttab='') {
2307     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
2309     $PAGE->set_title($data->name);
2310     echo $OUTPUT->header();
2311     echo $OUTPUT->heading(format_string($data->name), 2);
2312     echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro');
2314     // Groups needed for Add entry tab
2315     $currentgroup = groups_get_activity_group($cm);
2316     $groupmode = groups_get_activity_groupmode($cm);
2318     // Print the tabs
2320     if ($currenttab) {
2321         include('tabs.php');
2322     }
2324     // Print any notices
2326     if (!empty($displaynoticegood)) {
2327         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
2328     } else if (!empty($displaynoticebad)) {
2329         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
2330     }
2333 /**
2334  * Can user add more entries?
2335  *
2336  * @param object $data
2337  * @param mixed $currentgroup
2338  * @param int $groupmode
2339  * @param stdClass $context
2340  * @return bool
2341  */
2342 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2343     global $USER;
2345     if (empty($context)) {
2346         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2347         $context = context_module::instance($cm->id);
2348     }
2350     if (has_capability('mod/data:manageentries', $context)) {
2351         // no entry limits apply if user can manage
2353     } else if (!has_capability('mod/data:writeentry', $context)) {
2354         return false;
2356     } else if (data_atmaxentries($data)) {
2357         return false;
2358     } else if (data_in_readonly_period($data)) {
2359         // Check whether we're in a read-only period
2360         return false;
2361     }
2363     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2364         return true;
2365     }
2367     if ($currentgroup) {
2368         return groups_is_member($currentgroup);
2369     } else {
2370         //else it might be group 0 in visible mode
2371         if ($groupmode == VISIBLEGROUPS){
2372             return true;
2373         } else {
2374             return false;
2375         }
2376     }
2379 /**
2380  * Check whether the current user is allowed to manage the given record considering manageentries capability,
2381  * data_in_readonly_period() result, ownership (determined by data_isowner()) and manageapproved setting.
2382  * @param mixed $record record object or id
2383  * @param object $data data object
2384  * @param object $context context object
2385  * @return bool returns true if the user is allowd to edit the entry, false otherwise
2386  */
2387 function data_user_can_manage_entry($record, $data, $context) {
2388     global $DB;
2390     if (has_capability('mod/data:manageentries', $context)) {
2391         return true;
2392     }
2394     // Check whether this activity is read-only at present.
2395     $readonly = data_in_readonly_period($data);
2397     if (!$readonly) {
2398         // Get record object from db if just id given like in data_isowner.
2399         // ...done before calling data_isowner() to avoid querying db twice.
2400         if (!is_object($record)) {
2401             if (!$record = $DB->get_record('data_records', array('id' => $record))) {
2402                 return false;
2403             }
2404         }
2405         if (data_isowner($record)) {
2406             if ($data->approval && $record->approved) {
2407                 return $data->manageapproved == 1;
2408             } else {
2409                 return true;
2410             }
2411         }
2412     }
2414     return false;
2417 /**
2418  * Check whether the specified database activity is currently in a read-only period
2419  *
2420  * @param object $data
2421  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2422  */
2423 function data_in_readonly_period($data) {
2424     $now = time();
2425     if (!$data->timeviewfrom && !$data->timeviewto) {
2426         return false;
2427     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2428         return false;
2429     }
2430     return true;
2433 /**
2434  * @return bool
2435  */
2436 function is_directory_a_preset($directory) {
2437     $directory = rtrim($directory, '/\\') . '/';
2438     $status = file_exists($directory.'singletemplate.html') &&
2439               file_exists($directory.'listtemplate.html') &&
2440               file_exists($directory.'listtemplateheader.html') &&
2441               file_exists($directory.'listtemplatefooter.html') &&
2442               file_exists($directory.'addtemplate.html') &&
2443               file_exists($directory.'rsstemplate.html') &&
2444               file_exists($directory.'rsstitletemplate.html') &&
2445               file_exists($directory.'csstemplate.css') &&
2446               file_exists($directory.'jstemplate.js') &&
2447               file_exists($directory.'preset.xml');
2449     return $status;
2452 /**
2453  * Abstract class used for data preset importers
2454  */
2455 abstract class data_preset_importer {
2457     protected $course;
2458     protected $cm;
2459     protected $module;
2460     protected $directory;
2462     /**
2463      * Constructor
2464      *
2465      * @param stdClass $course
2466      * @param stdClass $cm
2467      * @param stdClass $module
2468      * @param string $directory
2469      */
2470     public function __construct($course, $cm, $module, $directory) {
2471         $this->course = $course;
2472         $this->cm = $cm;
2473         $this->module = $module;
2474         $this->directory = $directory;
2475     }
2477     /**
2478      * Returns the name of the directory the preset is located in
2479      * @return string
2480      */
2481     public function get_directory() {
2482         return basename($this->directory);
2483     }
2485     /**
2486      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2487      * @param file_storage $filestorage. should be null if using a conventional directory
2488      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2489      * @param string $dir the directory to look in. null if using the Moodle file storage
2490      * @param string $filename the name of the file we want
2491      * @return string the contents of the file or null if the file doesn't exist.
2492      */
2493     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2494         if(empty($filestorage) || empty($fileobj)) {
2495             if (substr($dir, -1)!='/') {
2496                 $dir .= '/';
2497             }
2498             if (file_exists($dir.$filename)) {
2499                 return file_get_contents($dir.$filename);
2500             } else {
2501                 return null;
2502             }
2503         } else {
2504             if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
2505                 $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2506                 return $file->get_content();
2507             } else {
2508                 return null;
2509             }
2510         }
2512     }
2513     /**
2514      * Gets the preset settings
2515      * @global moodle_database $DB
2516      * @return stdClass
2517      */
2518     public function get_preset_settings() {
2519         global $DB;
2521         $fs = $fileobj = null;
2522         if (!is_directory_a_preset($this->directory)) {
2523             //maybe the user requested a preset stored in the Moodle file storage
2525             $fs = get_file_storage();
2526             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2528             //preset name to find will be the final element of the directory
2529             $explodeddirectory = explode('/', $this->directory);
2530             $presettofind = end($explodeddirectory);
2532             //now go through the available files available and see if we can find it
2533             foreach ($files as $file) {
2534                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2535                     continue;
2536                 }
2537                 $presetname = trim($file->get_filepath(), '/');
2538                 if ($presetname==$presettofind) {
2539                     $this->directory = $presetname;
2540                     $fileobj = $file;
2541                 }
2542             }
2544             if (empty($fileobj)) {
2545                 print_error('invalidpreset', 'data', '', $this->directory);
2546             }
2547         }
2549         $allowed_settings = array(
2550             'intro',
2551             'comments',
2552             'requiredentries',
2553             'requiredentriestoview',
2554             'maxentries',
2555             'rssarticles',
2556             'approval',
2557             'defaultsortdir',
2558             'defaultsort');
2560         $result = new stdClass;
2561         $result->settings = new stdClass;
2562         $result->importfields = array();
2563         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2564         if (!$result->currentfields) {
2565             $result->currentfields = array();
2566         }
2569         /* Grab XML */
2570         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2571         $parsedxml = xmlize($presetxml, 0);
2573         /* First, do settings. Put in user friendly array. */
2574         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2575         $result->settings = new StdClass();
2576         foreach ($settingsarray as $setting => $value) {
2577             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2578                 // unsupported setting
2579                 continue;
2580             }
2581             $result->settings->$setting = $value[0]['#'];
2582         }
2584         /* Now work out fields to user friendly array */
2585         $fieldsarray = $parsedxml['preset']['#']['field'];
2586         foreach ($fieldsarray as $field) {
2587             if (!is_array($field)) {
2588                 continue;
2589             }
2590             $f = new StdClass();
2591             foreach ($field['#'] as $param => $value) {
2592                 if (!is_array($value)) {
2593                     continue;
2594                 }
2595                 $f->$param = $value[0]['#'];
2596             }
2597             $f->dataid = $this->module->id;
2598             $f->type = clean_param($f->type, PARAM_ALPHA);
2599             $result->importfields[] = $f;
2600         }
2601         /* Now add the HTML templates to the settings array so we can update d */
2602         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2603         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2604         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2605         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2606         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2607         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2608         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2609         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2610         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2611         $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2613         $result->settings->instance = $this->module->id;
2614         return $result;
2615     }
2617     /**
2618      * Import the preset into the given database module
2619      * @return bool
2620      */
2621     function import($overwritesettings) {
2622         global $DB, $CFG;
2624         $params = $this->get_preset_settings();
2625         $settings = $params->settings;
2626         $newfields = $params->importfields;
2627         $currentfields = $params->currentfields;
2628         $preservedfields = array();
2630         /* Maps fields and makes new ones */
2631         if (!empty($newfields)) {
2632             /* We require an injective mapping, and need to know what to protect */
2633             foreach ($newfields as $nid => $newfield) {
2634                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2635                 if ($cid == -1) {
2636                     continue;
2637                 }
2638                 if (array_key_exists($cid, $preservedfields)){
2639                     print_error('notinjectivemap', 'data');
2640                 }
2641                 else $preservedfields[$cid] = true;
2642             }
2644             foreach ($newfields as $nid => $newfield) {
2645                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2647                 /* A mapping. Just need to change field params. Data kept. */
2648                 if ($cid != -1 and isset($currentfields[$cid])) {
2649                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2650                     foreach ($newfield as $param => $value) {
2651                         if ($param != "id") {
2652                             $fieldobject->field->$param = $value;
2653                         }
2654                     }
2655                     unset($fieldobject->field->similarfield);
2656                     $fieldobject->update_field();
2657                     unset($fieldobject);
2658                 } else {
2659                     /* Make a new field */
2660                     include_once("field/$newfield->type/field.class.php");
2662                     if (!isset($newfield->description)) {
2663                         $newfield->description = '';
2664                     }
2665                     $classname = 'data_field_'.$newfield->type;
2666                     $fieldclass = new $classname($newfield, $this->module);
2667                     $fieldclass->insert_field();
2668                     unset($fieldclass);
2669                 }
2670             }
2671         }
2673         /* Get rid of all old unused data */
2674         if (!empty($preservedfields)) {
2675             foreach ($currentfields as $cid => $currentfield) {
2676                 if (!array_key_exists($cid, $preservedfields)) {
2677                     /* Data not used anymore so wipe! */
2678                     print "Deleting field $currentfield->name<br />";
2680                     $id = $currentfield->id;
2681                     //Why delete existing data records and related comments/ratings??
2682                     $DB->delete_records('data_content', array('fieldid'=>$id));
2683                     $DB->delete_records('data_fields', array('id'=>$id));
2684                 }
2685             }
2686         }
2688         // handle special settings here
2689         if (!empty($settings->defaultsort)) {
2690             if (is_numeric($settings->defaultsort)) {
2691                 // old broken value
2692                 $settings->defaultsort = 0;
2693             } else {
2694                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2695             }
2696         } else {
2697             $settings->defaultsort = 0;
2698         }
2700         // do we want to overwrite all current database settings?
2701         if ($overwritesettings) {
2702             // all supported settings
2703             $overwrite = array_keys((array)$settings);
2704         } else {
2705             // only templates and sorting
2706             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2707                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2708                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2709         }
2711         // now overwrite current data settings
2712         foreach ($this->module as $prop=>$unused) {
2713             if (in_array($prop, $overwrite)) {
2714                 $this->module->$prop = $settings->$prop;
2715             }
2716         }
2718         data_update_instance($this->module);
2720         return $this->cleanup();
2721     }
2723     /**
2724      * Any clean up routines should go here
2725      * @return bool
2726      */
2727     public function cleanup() {
2728         return true;
2729     }
2732 /**
2733  * Data preset importer for uploaded presets
2734  */
2735 class data_preset_upload_importer extends data_preset_importer {
2736     public function __construct($course, $cm, $module, $filepath) {
2737         global $USER;
2738         if (is_file($filepath)) {
2739             $fp = get_file_packer();
2740             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2741                 fulldelete($filepath);
2742             }
2743             $filepath .= '_extracted';
2744         }
2745         parent::__construct($course, $cm, $module, $filepath);
2746     }
2747     public function cleanup() {
2748         return fulldelete($this->directory);
2749     }
2752 /**
2753  * Data preset importer for existing presets
2754  */
2755 class data_preset_existing_importer extends data_preset_importer {
2756     protected $userid;
2757     public function __construct($course, $cm, $module, $fullname) {
2758         global $USER;
2759         list($userid, $shortname) = explode('/', $fullname, 2);
2760         $context = context_module::instance($cm->id);
2761         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2762            throw new coding_exception('Invalid preset provided');
2763         }
2765         $this->userid = $userid;
2766         $filepath = data_preset_path($course, $userid, $shortname);
2767         parent::__construct($course, $cm, $module, $filepath);
2768     }
2769     public function get_userid() {
2770         return $this->userid;
2771     }
2774 /**
2775  * @global object
2776  * @global object
2777  * @param object $course
2778  * @param int $userid
2779  * @param string $shortname
2780  * @return string
2781  */
2782 function data_preset_path($course, $userid, $shortname) {
2783     global $USER, $CFG;
2785     $context = context_course::instance($course->id);
2787     $userid = (int)$userid;
2789     $path = null;
2790     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2791         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2792     } else if ($userid == 0) {
2793         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2794     } else if ($userid < 0) {
2795         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2796     }
2798     return $path;
2801 /**
2802  * Implementation of the function for printing the form elements that control
2803  * whether the course reset functionality affects the data.
2804  *
2805  * @param $mform form passed by reference
2806  */
2807 function data_reset_course_form_definition(&$mform) {
2808     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2809     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2811     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2812     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2814     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2815     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2817     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2818     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2820     $mform->addElement('checkbox', 'reset_data_tags', get_string('removealldatatags', 'data'));
2821     $mform->disabledIf('reset_data_tags', 'reset_data', 'checked');
2824 /**
2825  * Course reset form defaults.
2826  * @return array
2827  */
2828 function data_reset_course_form_defaults($course) {
2829     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2832 /**
2833  * Removes all grades from gradebook
2834  *
2835  * @global object
2836  * @global object
2837  * @param int $courseid
2838  * @param string $type optional type
2839  */
2840 function data_reset_gradebook($courseid, $type='') {
2841     global $CFG, $DB;
2843     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2844               FROM {data} d, {course_modules} cm, {modules} m
2845              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2847     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2848         foreach ($datas as $data) {
2849             data_grade_item_update($data, 'reset');
2850         }
2851     }
2854 /**
2855  * Actual implementation of the reset course functionality, delete all the
2856  * data responses for course $data->courseid.
2857  *
2858  * @global object
2859  * @global object
2860  * @param object $data the data submitted from the reset course.
2861  * @return array status array
2862  */
2863 function data_reset_userdata($data) {
2864     global $CFG, $DB;
2865     require_once($CFG->libdir.'/filelib.php');
2866     require_once($CFG->dirroot.'/rating/lib.php');
2868     $componentstr = get_string('modulenameplural', 'data');
2869     $status = array();
2871     $allrecordssql = "SELECT r.id
2872                         FROM {data_records} r
2873                              INNER JOIN {data} d ON r.dataid = d.id
2874                        WHERE d.course = ?";
2876     $alldatassql = "SELECT d.id
2877                       FROM {data} d
2878                      WHERE d.course=?";
2880     $rm = new rating_manager();
2881     $ratingdeloptions = new stdClass;
2882     $ratingdeloptions->component = 'mod_data';
2883     $ratingdeloptions->ratingarea = 'entry';
2885     // Set the file storage - may need it to remove files later.
2886     $fs = get_file_storage();
2888     // delete entries if requested
2889     if (!empty($data->reset_data)) {
2890         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2891         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2892         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2894         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2895             foreach ($datas as $dataid=>$unused) {
2896                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2897                     continue;
2898                 }
2899                 $datacontext = context_module::instance($cm->id);
2901                 // Delete any files that may exist.
2902                 $fs->delete_area_files($datacontext->id, 'mod_data', 'content');
2904                 $ratingdeloptions->contextid = $datacontext->id;
2905                 $rm->delete_ratings($ratingdeloptions);
2907                 core_tag_tag::delete_instances('mod_data', null, $datacontext->id);
2908             }
2909         }
2911         if (empty($data->reset_gradebook_grades)) {
2912             // remove all grades from gradebook
2913             data_reset_gradebook($data->courseid);
2914         }
2915         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2916     }
2918     // remove entries by users not enrolled into course
2919     if (!empty($data->reset_data_notenrolled)) {
2920         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2921                          FROM {data_records} r
2922                               JOIN {data} d ON r.dataid = d.id
2923                               LEFT JOIN {user} u ON r.userid = u.id
2924                         WHERE d.course = ? AND r.userid > 0";
2926         $course_context = context_course::instance($data->courseid);
2927         $notenrolled = array();
2928         $fields = array();
2929         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2930         foreach ($rs as $record) {
2931             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2932               or !is_enrolled($course_context, $record->userid)) {
2933                 //delete ratings
2934                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2935                     continue;
2936                 }
2937                 $datacontext = context_module::instance($cm->id);
2938                 $ratingdeloptions->contextid = $datacontext->id;
2939                 $ratingdeloptions->itemid = $record->id;
2940                 $rm->delete_ratings($ratingdeloptions);
2942                 // Delete any files that may exist.
2943                 if ($contents = $DB->get_records('data_content', array('recordid' => $record->id), '', 'id')) {
2944                     foreach ($contents as $content) {
2945                         $fs->delete_area_files($datacontext->id, 'mod_data', 'content', $content->id);
2946                     }
2947                 }
2948                 $notenrolled[$record->userid] = true;
2950                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $record->id);
2952                 $DB->delete_records('comments', array('itemid' => $record->id, 'commentarea' => 'database_entry'));
2953                 $DB->delete_records('data_content', array('recordid' => $record->id));
2954                 $DB->delete_records('data_records', array('id' => $record->id));
2955             }
2956         }
2957         $rs->close();
2958         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2959     }
2961     // remove all ratings
2962     if (!empty($data->reset_data_ratings)) {
2963         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2964             foreach ($datas as $dataid=>$unused) {
2965                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2966                     continue;
2967                 }
2968                 $datacontext = context_module::instance($cm->id);
2970                 $ratingdeloptions->contextid = $datacontext->id;
2971                 $rm->delete_ratings($ratingdeloptions);
2972             }
2973         }
2975         if (empty($data->reset_gradebook_grades)) {
2976             // remove all grades from gradebook
2977             data_reset_gradebook($data->courseid);
2978         }
2980         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2981     }
2983     // remove all comments
2984     if (!empty($data->reset_data_comments)) {
2985         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2986         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2987     }
2989     // Remove all the tags.
2990     if (!empty($data->reset_data_tags)) {
2991         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2992             foreach ($datas as $dataid => $unused) {
2993                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2994                     continue;
2995                 }
2997                 $context = context_module::instance($cm->id);
2998                 core_tag_tag::delete_instances('mod_data', null, $context->id);
3000             }
3001         }
3002         $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'data'), 'error' => false);
3003     }
3005     // updating dates - shift may be negative too
3006     if ($data->timeshift) {
3007         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
3008         // See MDL-9367.
3009         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto',
3010             'timeviewfrom', 'timeviewto', 'assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
3011         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3012     }
3014     return $status;
3017 /**
3018  * Returns all other caps used in module
3019  *
3020  * @return array
3021  */
3022 function data_get_extra_capabilities() {
3023     return ['moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate',
3024             'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete'];
3027 /**
3028  * @param string $feature FEATURE_xx constant for requested feature
3029  * @return mixed True if module supports feature, null if doesn't know
3030  */
3031 function data_supports($feature) {
3032     switch($feature) {
3033         case FEATURE_GROUPS:                  return true;
3034         case FEATURE_GROUPINGS:               return true;
3035         case FEATURE_MOD_INTRO:               return true;
3036         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
3037         case FEATURE_COMPLETION_HAS_RULES:    return true;
3038         case FEATURE_GRADE_HAS_GRADE:         return true;
3039         case FEATURE_GRADE_OUTCOMES:          return true;
3040         case FEATURE_RATE:                    return true;
3041         case FEATURE_BACKUP_MOODLE2:          return true;
3042         case FEATURE_SHOW_DESCRIPTION:        return true;
3043         case FEATURE_COMMENT:                 return true;
3045         default: return null;
3046     }
3048 /**
3049  * @global object
3050  * @param array $export
3051  * @param string $delimiter_name
3052  * @param object $database
3053  * @param int $count
3054  * @param bool $return
3055  * @return string|void
3056  */
3057 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
3058     global $CFG;
3059     require_once($CFG->libdir . '/csvlib.class.php');
3061     $filename = $database . '-' . $count . '-record';
3062     if ($count > 1) {
3063         $filename .= 's';
3064     }
3065     if ($return) {
3066         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
3067     } else {
3068         csv_export_writer::download_array($filename, $export, $delimiter_name);
3069     }
3072 /**
3073  * @global object
3074  * @param array $export
3075  * @param string $dataname
3076  * @param int $count
3077  * @return string
3078  */
3079 function data_export_xls($export, $dataname, $count) {
3080     global $CFG;
3081     require_once("$CFG->libdir/excellib.class.php");
3082     $filename = clean_filename("{$dataname}-{$count}_record");
3083     if ($count > 1) {
3084         $filename .= 's';
3085     }
3086     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3087     $filename .= '.xls';
3089     $filearg = '-';
3090     $workbook = new MoodleExcelWorkbook($filearg);
3091     $workbook->send($filename);
3092     $worksheet = array();
3093     $worksheet[0] = $workbook->add_worksheet('');
3094     $rowno = 0;
3095     foreach ($export as $row) {
3096         $colno = 0;
3097         foreach($row as $col) {
3098             $worksheet[0]->write($rowno, $colno, $col);
3099             $colno++;
3100         }
3101         $rowno++;
3102     }
3103     $workbook->close();
3104     return $filename;
3107 /**
3108  * @global object
3109  * @param array $export
3110  * @param string $dataname
3111  * @param int $count
3112  * @param string
3113  */
3114 function data_export_ods($export, $dataname, $count) {
3115     global $CFG;
3116     require_once("$CFG->libdir/odslib.class.php");
3117     $filename = clean_filename("{$dataname}-{$count}_record");
3118     if ($count > 1) {
3119         $filename .= 's';
3120     }
3121     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3122     $filename .= '.ods';
3123     $filearg = '-';
3124     $workbook = new MoodleODSWorkbook($filearg);
3125     $workbook->send($filename);
3126     $worksheet = array();
3127     $worksheet[0] = $workbook->add_worksheet('');
3128     $rowno = 0;
3129     foreach ($export as $row) {
3130         $colno = 0;
3131         foreach($row as $col) {
3132             $worksheet[0]->write($rowno, $colno, $col);
3133             $colno++;
3134         }
3135         $rowno++;
3136     }
3137     $workbook->close();
3138     return $filename;
3141 /**
3142  * @global object
3143  * @param int $dataid
3144  * @param array $fields
3145  * @param array $selectedfields
3146  * @param int $currentgroup group ID of the current group. This is used for
3147  * exporting data while maintaining group divisions.
3148  * @param object $context the context in which the operation is performed (for capability checks)
3149  * @param bool $userdetails whether to include the details of the record author
3150  * @param bool $time whether to include time created/modified
3151  * @param bool $approval whether to include approval status
3152  * @param bool $tags whether to include tags
3153  * @return array
3154  */
3155 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
3156                              $userdetails=false, $time=false, $approval=false, $tags = false) {
3157     global $DB;
3159     if (is_null($context)) {
3160         $context = context_system::instance();
3161     }
3162     // exporting user data needs special permission
3163     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
3165     $exportdata = array();
3167     // populate the header in first row of export
3168     foreach($fields as $key => $field) {
3169         if (!in_array($field->field->id, $selectedfields)) {
3170             // ignore values we aren't exporting
3171             unset($fields[$key]);
3172         } else {
3173             $exportdata[0][] = $field->field->name;
3174         }
3175     }
3176     if ($tags) {
3177         $exportdata[0][] = get_string('tags', 'data');
3178     }
3179     if ($userdetails) {
3180         $exportdata[0][] = get_string('user');
3181         $exportdata[0][] = get_string('username');
3182         $exportdata[0][] = get_string('email');
3183     }
3184     if ($time) {
3185         $exportdata[0][] = get_string('timeadded', 'data');
3186         $exportdata[0][] = get_string('timemodified', 'data');
3187     }
3188     if ($approval) {
3189         $exportdata[0][] = get_string('approved', 'data');
3190     }
3192     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
3193     ksort($datarecords);
3194     $line = 1;
3195     foreach($datarecords as $record) {
3196         // get content indexed by fieldid
3197         if ($currentgroup) {
3198             $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 = ?';
3199             $where = array($record->id, $currentgroup);
3200         } else {
3201             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
3202             $where = array($record->id);
3203         }
3205         if( $content = $DB->get_records_sql($select, $where) ) {
3206             foreach($fields as $field) {
3207                 $contents = '';
3208                 if(isset($content[$field->field->id])) {
3209                     $contents = $field->export_text_value($content[$field->field->id]);
3210                 }
3211                 $exportdata[$line][] = $contents;
3212             }
3213             if ($tags) {
3214                 $itemtags = \core_tag_tag::get_item_tags_array('mod_data', 'data_records', $record->id);
3215                 $exportdata[$line][] = implode(', ', $itemtags);
3216             }
3217             if ($userdetails) { // Add user details to the export data
3218                 $userdata = get_complete_user_data('id', $record->userid);
3219                 $exportdata[$line][] = fullname($userdata);
3220                 $exportdata[$line][] = $userdata->username;
3221                 $exportdata[$line][] = $userdata->email;
3222             }
3223             if ($time) { // Add time added / modified
3224                 $exportdata[$line][] = userdate($record->timecreated);
3225                 $exportdata[$line][] = userdate($record->timemodified);
3226             }
3227             if ($approval) { // Add approval status
3228                 $exportdata[$line][] = (int) $record->approved;
3229             }
3230         }
3231         $line++;
3232     }
3233     $line--;
3234     return $exportdata;
3237 ////////////////////////////////////////////////////////////////////////////////
3238 // File API                                                                   //
3239 ////////////////////////////////////////////////////////////////////////////////
3241 /**
3242  * Lists all browsable file areas
3243  *
3244  * @package  mod_data
3245  * @category files
3246  * @param stdClass $course course object
3247  * @param stdClass $cm course module object
3248  * @param stdClass $context context object
3249  * @return array
3250  */
3251 function data_get_file_areas($course, $cm, $context) {
3252     return array('content' => get_string('areacontent', 'mod_data'));
3255 /**
3256  * File browsing support for data module.
3257  *
3258  * @param file_browser $browser
3259  * @param array $areas
3260  * @param stdClass $course
3261  * @param cm_info $cm
3262  * @param context $context
3263  * @param string $filearea
3264  * @param int $itemid
3265  * @param string $filepath
3266  * @param string $filename
3267  * @return file_info_stored file_info_stored instance or null if not found
3268  */
3269 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
3270     global $CFG, $DB, $USER;
3272     if ($context->contextlevel != CONTEXT_MODULE) {
3273         return null;
3274     }
3276     if (!isset($areas[$filearea])) {
3277         return null;
3278     }
3280     if (is_null($itemid)) {
3281         require_once($CFG->dirroot.'/mod/data/locallib.php');
3282         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
3283     }
3285     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
3286         return null;
3287     }
3289     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3290         return null;
3291     }
3293     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3294         return null;
3295     }
3297     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3298         return null;
3299     }
3301     //check if approved
3302     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3303         return null;
3304     }
3306     // group access
3307     if ($record->groupid) {
3308         $groupmode = groups_get_activity_groupmode($cm, $course);
3309         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3310             if (!groups_is_member($record->groupid)) {
3311                 return null;
3312             }
3313         }
3314     }
3316     $fieldobj = data_get_field($field, $data, $cm);
3318     $filepath = is_null($filepath) ? '/' : $filepath;
3319     $filename = is_null($filename) ? '.' : $filename;
3320     if (!$fieldobj->file_ok($filepath.$filename)) {
3321         return null;
3322     }
3324     $fs = get_file_storage();
3325     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
3326         return null;
3327     }
3329     // Checks to see if the user can manage files or is the owner.
3330     // TODO MDL-33805 - Do not use userid here and move the capability check above.
3331     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
3332         return null;
3333     }
3335     $urlbase = $CFG->wwwroot.'/pluginfile.php';
3337     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
3340 /**
3341  * Serves the data attachments. Implements needed access control ;-)
3342  *
3343  * @package  mod_data
3344  * @category files
3345  * @param stdClass $course course object
3346  * @param stdClass $cm course module object
3347  * @param stdClass $context context object
3348  * @param string $filearea file area
3349  * @param array $args extra arguments
3350  * @param bool $forcedownload whether or not force download
3351  * @param array $options additional options affecting the file serving
3352  * @return bool false if file not found, does not return if found - justsend the file
3353  */
3354 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
3355     global $CFG, $DB;
3357     if ($context->contextlevel != CONTEXT_MODULE) {
3358         return false;
3359     }
3361     require_course_login($course, true, $cm);
3363     if ($filearea === 'content') {
3364         $contentid = (int)array_shift($args);
3366         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
3367             return false;
3368         }
3370         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3371             return false;
3372         }
3374         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3375             return false;
3376         }
3378         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3379             return false;
3380         }
3382         if ($data->id != $cm->instance) {
3383             // hacker attempt - context does not match the contentid
3384             return false;
3385         }
3387         //check if approved
3388         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3389             return false;
3390         }
3392         // group access
3393         if ($record->groupid) {
3394             $groupmode = groups_get_activity_groupmode($cm, $course);
3395             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3396                 if (!groups_is_member($record->groupid)) {
3397                     return false;
3398                 }
3399             }
3400         }
3402         $fieldobj = data_get_field($field, $data, $cm);
3404         $relativepath = implode('/', $args);
3405         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
3407         if (!$fieldobj->file_ok($relativepath)) {
3408             return false;
3409         }
3411         $fs = get_file_storage();
3412         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3413             return false;
3414         }
3416         // finally send the file
3417         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
3418     }
3420     return false;
3424 function data_extend_navigation($navigation, $course, $module, $cm) {
3425     global $CFG, $OUTPUT, $USER, $DB;
3426     require_once($CFG->dirroot . '/mod/data/locallib.php');
3428     $rid = optional_param('rid', 0, PARAM_INT);
3430     $data = $DB->get_record('data', array('id'=>$cm->instance));
3431     $currentgroup = groups_get_activity_group($cm);
3432     $groupmode = groups_get_activity_groupmode($cm);
3434      $numentries = data_numentries($data);
3435     $canmanageentries = has_capability('mod/data:manageentries', context_module::instance($cm->id));
3437     if ($data->entriesleft = data_get_entries_left_to_add($data, $numentries, $canmanageentries)) {
3438         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3439         $entriesnode->add_class('note');
3440     }
3442     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3443     if (!empty($rid)) {
3444         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3445     } else {
3446         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3447     }
3448     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3451 /**
3452  * Adds module specific settings to the settings block
3453  *
3454  * @param settings_navigation $settings The settings navigation object
3455  * @param navigation_node $datanode The node to add module settings to
3456  */
3457 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3458     global $PAGE, $DB, $CFG, $USER;
3460     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3462     $currentgroup = groups_get_activity_group($PAGE->cm);
3463     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3465     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3466         if (empty($editentry)) { //TODO: undefined
3467             $addstring = get_string('add', 'data');
3468         } else {
3469             $addstring = get_string('editentry', 'data');
3470         }
3471         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3472     }
3474     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3475         // The capability required to Export database records is centrally defined in 'lib.php'
3476         // and should be weaker than those required to edit Templates, Fields and Presets.
3477         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3478     }
3479     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3480         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3481     }
3483     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3484         $currenttab = '';
3485         if ($currenttab == 'list') {
3486             $defaultemplate = 'listtemplate';
3487         } else if ($currenttab == 'add') {
3488             $defaultemplate = 'addtemplate';
3489         } else if ($currenttab == 'asearch') {
3490             $defaultemplate = 'asearchtemplate';
3491         } else {
3492             $defaultemplate = 'singletemplate';
3493         }
3495         $templates = $datanode->add(get_string('templates', 'data'));
3497         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3498         foreach ($templatelist as $template) {
3499             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3500         }
3502         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3503         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3504     }
3506     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3507         require_once("$CFG->libdir/rsslib.php");
3509         $string = get_string('rsstype','forum');
3511         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3512         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3513     }
3516 /**
3517  * Save the database configuration as a preset.
3518  *
3519  * @param stdClass $course The course the database module belongs to.
3520  * @param stdClass $cm The course module record
3521  * @param stdClass $data The database record
3522  * @param string $path
3523  * @return bool
3524  */
3525 function data_presets_save($course, $cm, $data, $path) {
3526     global $USER;
3527     $fs = get_file_storage();
3528     $filerecord = new stdClass;
3529     $filerecord->contextid = DATA_PRESET_CONTEXT;
3530     $filerecord->component = DATA_PRESET_COMPONENT;
3531     $filerecord->filearea = DATA_PRESET_FILEAREA;
3532     $filerecord->itemid = 0;
3533     $filerecord->filepath = '/'.$path.'/';
3534     $filerecord->userid = $USER->id;
3536     $filerecord->filename = 'preset.xml';
3537     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3539     $filerecord->filename = 'singletemplate.html';
3540     $fs->create_file_from_string($filerecord, $data->singletemplate);
3542     $filerecord->filename = 'listtemplateheader.html';
3543     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3545     $filerecord->filename = 'listtemplate.html';
3546     $fs->create_file_from_string($filerecord, $data->listtemplate);
3548     $filerecord->filename = 'listtemplatefooter.html';
3549     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3551     $filerecord->filename = 'addtemplate.html';
3552     $fs->create_file_from_string($filerecord, $data->addtemplate);
3554     $filerecord->filename = 'rsstemplate.html';
3555     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3557     $filerecord->filename = 'rsstitletemplate.html';
3558     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3560     $filerecord->filename = 'csstemplate.css';
3561     $fs->create_file_from_string($filerecord, $data->csstemplate);
3563     $filerecord->filename = 'jstemplate.js';
3564     $fs->create_file_from_string($filerecord, $data->jstemplate);
3566     $filerecord->filename = 'asearchtemplate.html';
3567     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3569     return true;
3572 /**
3573  * Generates the XML for the database module provided
3574  *
3575  * @global moodle_database $DB
3576  * @param stdClass $course The course the database module belongs to.
3577  * @param stdClass $cm The course module record
3578  * @param stdClass $data The database record
3579  * @return string The XML for the preset
3580  */
3581 function data_presets_generate_xml($course, $cm, $data) {
3582     global $DB;
3584     // Assemble "preset.xml":
3585     $presetxmldata = "<preset>\n\n";
3587     // Raw settings are not preprocessed during saving of presets
3588     $raw_settings = array(
3589         'intro',
3590         'comments',
3591         'requiredentries',
3592         'requiredentriestoview',
3593         'maxentries',
3594         'rssarticles',
3595         'approval',
3596         'manageapproved',
3597         'defaultsortdir'
3598     );
3600     $presetxmldata .= "<settings>\n";
3601     // First, settings that do not require any conversion
3602     foreach ($raw_settings as $setting) {
3603         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3604     }
3606     // Now specific settings
3607     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3608         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3609     } else {
3610         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3611     }
3612     $presetxmldata .= "</settings>\n\n";
3613     // Now for the fields. Grab all that are non-empty
3614     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3615     ksort($fields);
3616     if (!empty($fields)) {
3617         foreach ($fields as $field) {
3618             $presetxmldata .= "<field>\n";
3619             foreach ($field as $key => $value) {
3620                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3621                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3622                 }
3623             }
3624             $presetxmldata .= "</field>\n\n";
3625         }
3626     }
3627     $presetxmldata .= '</preset>';
3628     return $presetxmldata;
3631 function data_presets_export($course, $cm, $data, $tostorage=false) {
3632     global $CFG, $DB;
3634     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3635     $exportsubdir = "mod_data/presetexport/$presetname";
3636     make_temp_directory($exportsubdir);
3637     $exportdir = "$CFG->tempdir/$exportsubdir";
3639     // Assemble "preset.xml":
3640     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3642     // After opening a file in write mode, close it asap
3643     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3644     fwrite($presetxmlfile, $presetxmldata);
3645     fclose($presetxmlfile);
3647     // Now write the template files
3648     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3649     fwrite($singletemplate, $data->singletemplate);
3650     fclose($singletemplate);
3652     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3653     fwrite($listtemplateheader, $data->listtemplateheader);
3654     fclose($listtemplateheader);
3656     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3657     fwrite($listtemplate, $data->listtemplate);
3658     fclose($listtemplate);
3660     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3661     fwrite($listtemplatefooter, $data->listtemplatefooter);
3662     fclose($listtemplatefooter);
3664     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3665     fwrite($addtemplate, $data->addtemplate);
3666     fclose($addtemplate);
3668     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3669     fwrite($rsstemplate, $data->rsstemplate);
3670     fclose($rsstemplate