Merge branch 'MDL-65933-master' of git://github.com/junpataleta/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             $checkbox = new \core\output\checkbox_toggleall('listview-entries', false, [
1452                 'id' => "entry_{$record->id}",
1453                 'name' => 'delcheck[]',
1454                 'class' => 'recordcheckbox',
1455                 'value' => $record->id,
1456             ]);
1457             $replacement[] = $OUTPUT->render($checkbox);
1458         } else {
1459             $replacement[] = '';
1460         }
1462         $patterns[]='##user##';
1463         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1464                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1466         $patterns[] = '##userpicture##';
1467         $ruser = user_picture::unalias($record, null, 'userid');
1468         // If the record didn't come with user data, retrieve the user from database.
1469         if (!isset($ruser->picture)) {
1470             $ruser = core_user::get_user($record->userid);
1471         }
1472         $replacement[] = $OUTPUT->user_picture($ruser, array('courseid' => $data->course));
1474         $patterns[]='##export##';
1476         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1477             && ((has_capability('mod/data:exportentry', $context)
1478                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1479             require_once($CFG->libdir . '/portfoliolib.php');
1480             $button = new portfolio_add_button();
1481             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), 'mod_data');
1482             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1483             $button->set_formats($formats);
1484             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1485         } else {
1486             $replacement[] = '';
1487         }
1489         $patterns[] = '##timeadded##';
1490         $replacement[] = userdate($record->timecreated);
1492         $patterns[] = '##timemodified##';
1493         $replacement [] = userdate($record->timemodified);
1495         $patterns[]='##approve##';
1496         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)) {
1497             $approveurl = new moodle_url($jumpurl, array('approve' => $record->id));
1498             $approveicon = new pix_icon('t/approve', get_string('approve', 'data'), '', array('class' => 'iconsmall'));
1499             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($approveurl, $approveicon),
1500                     array('class' => 'approve'));
1501         } else {
1502             $replacement[] = '';
1503         }
1505         $patterns[]='##disapprove##';
1506         if (has_capability('mod/data:approve', $context) && ($data->approval) && ($record->approved)) {
1507             $disapproveurl = new moodle_url($jumpurl, array('disapprove' => $record->id));
1508             $disapproveicon = new pix_icon('t/block', get_string('disapprove', 'data'), '', array('class' => 'iconsmall'));
1509             $replacement[] = html_writer::tag('span', $OUTPUT->action_icon($disapproveurl, $disapproveicon),
1510                     array('class' => 'disapprove'));
1511         } else {
1512             $replacement[] = '';
1513         }
1515         $patterns[] = '##approvalstatus##';
1516         $patterns[] = '##approvalstatusclass##';
1517         if (!$data->approval) {
1518             $replacement[] = '';
1519             $replacement[] = '';
1520         } else if ($record->approved) {
1521             $replacement[] = get_string('approved', 'data');
1522             $replacement[] = 'approved';
1523         } else {
1524             $replacement[] = get_string('notapproved', 'data');
1525             $replacement[] = 'notapproved';
1526         }
1528         $patterns[]='##comments##';
1529         if (($template == 'listtemplate') && ($data->comments)) {
1531             if (!empty($CFG->usecomments)) {
1532                 require_once($CFG->dirroot  . '/comment/lib.php');
1533                 list($context, $course, $cm) = get_context_info_array($context->id);
1534                 $cmt = new stdClass();
1535                 $cmt->context = $context;
1536                 $cmt->course  = $course;
1537                 $cmt->cm      = $cm;
1538                 $cmt->area    = 'database_entry';
1539                 $cmt->itemid  = $record->id;
1540                 $cmt->showcount = true;
1541                 $cmt->component = 'mod_data';
1542                 $comment = new comment($cmt);
1543                 $replacement[] = $comment->output(true);
1544             }
1545         } else {
1546             $replacement[] = '';
1547         }
1549         if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1550             $patterns[] = "##tags##";
1551             $replacement[] = $OUTPUT->tag_list(
1552                 core_tag_tag::get_item_tags('mod_data', 'data_records', $record->id), '', 'data-tags');
1553         }
1555         // actual replacement of the tags
1556         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1558         // no more html formatting and filtering - see MDL-6635
1559         if ($return) {
1560             return $newtext;
1561         } else {
1562             echo $newtext;
1564             // hack alert - return is always false in singletemplate anyway ;-)
1565             /**********************************
1566              *    Printing Ratings Form       *
1567              *********************************/
1568             if ($template == 'singletemplate') {    //prints ratings options
1569                 data_print_ratings($data, $record);
1570             }
1572             /**********************************
1573              *    Printing Comments Form       *
1574              *********************************/
1575             if (($template == 'singletemplate') && ($data->comments)) {
1576                 if (!empty($CFG->usecomments)) {
1577                     require_once($CFG->dirroot . '/comment/lib.php');
1578                     list($context, $course, $cm) = get_context_info_array($context->id);
1579                     $cmt = new stdClass();
1580                     $cmt->context = $context;
1581                     $cmt->course  = $course;
1582                     $cmt->cm      = $cm;
1583                     $cmt->area    = 'database_entry';
1584                     $cmt->itemid  = $record->id;
1585                     $cmt->showcount = true;
1586                     $cmt->component = 'mod_data';
1587                     $comment = new comment($cmt);
1588                     $comment->output(false);
1589                 }
1590             }
1591         }
1592     }
1595 /**
1596  * Return rating related permissions
1597  *
1598  * @param string $contextid the context id
1599  * @param string $component the component to get rating permissions for
1600  * @param string $ratingarea the rating area to get permissions for
1601  * @return array an associative array of the user's rating permissions
1602  */
1603 function data_rating_permissions($contextid, $component, $ratingarea) {
1604     $context = context::instance_by_id($contextid, MUST_EXIST);
1605     if ($component != 'mod_data' || $ratingarea != 'entry') {
1606         return null;
1607     }
1608     return array(
1609         'view'    => has_capability('mod/data:viewrating',$context),
1610         'viewany' => has_capability('mod/data:viewanyrating',$context),
1611         'viewall' => has_capability('mod/data:viewallratings',$context),
1612         'rate'    => has_capability('mod/data:rate',$context)
1613     );
1616 /**
1617  * Validates a submitted rating
1618  * @param array $params submitted data
1619  *            context => object the context in which the rated items exists [required]
1620  *            itemid => int the ID of the object being rated
1621  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1622  *            rating => int the submitted rating
1623  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1624  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1625  * @return boolean true if the rating is valid. Will throw rating_exception if not
1626  */
1627 function data_rating_validate($params) {
1628     global $DB, $USER;
1630     // Check the component is mod_data
1631     if ($params['component'] != 'mod_data') {
1632         throw new rating_exception('invalidcomponent');
1633     }
1635     // Check the ratingarea is entry (the only rating area in data module)
1636     if ($params['ratingarea'] != 'entry') {
1637         throw new rating_exception('invalidratingarea');
1638     }
1640     // Check the rateduserid is not the current user .. you can't rate your own entries
1641     if ($params['rateduserid'] == $USER->id) {
1642         throw new rating_exception('nopermissiontorate');
1643     }
1645     $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
1646                   FROM {data_records} r
1647                   JOIN {data} d ON r.dataid = d.id
1648                  WHERE r.id = :itemid";
1649     $dataparams = array('itemid'=>$params['itemid']);
1650     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1651         //item doesn't exist
1652         throw new rating_exception('invaliditemid');
1653     }
1655     if ($info->scale != $params['scaleid']) {
1656         //the scale being submitted doesnt match the one in the database
1657         throw new rating_exception('invalidscaleid');
1658     }
1660     //check that the submitted rating is valid for the scale
1662     // lower limit
1663     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1664         throw new rating_exception('invalidnum');
1665     }
1667     // upper limit
1668     if ($info->scale < 0) {
1669         //its a custom scale
1670         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1671         if ($scalerecord) {
1672             $scalearray = explode(',', $scalerecord->scale);
1673             if ($params['rating'] > count($scalearray)) {
1674                 throw new rating_exception('invalidnum');
1675             }
1676         } else {
1677             throw new rating_exception('invalidscaleid');
1678         }
1679     } else if ($params['rating'] > $info->scale) {
1680         //if its numeric and submitted rating is above maximum
1681         throw new rating_exception('invalidnum');
1682     }
1684     if ($info->approval && !$info->approved) {
1685         //database requires approval but this item isnt approved
1686         throw new rating_exception('nopermissiontorate');
1687     }
1689     // check the item we're rating was created in the assessable time window
1690     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1691         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1692             throw new rating_exception('notavailable');
1693         }
1694     }
1696     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1697     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1698     $context = context_module::instance($cm->id);
1700     // if the supplied context doesnt match the item's context
1701     if ($context->id != $params['context']->id) {
1702         throw new rating_exception('invalidcontext');
1703     }
1705     // Make sure groups allow this user to see the item they're rating
1706     $groupid = $info->groupid;
1707     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1708         if (!groups_group_exists($groupid)) { // Can't find group
1709             throw new rating_exception('cannotfindgroup');//something is wrong
1710         }
1712         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1713             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1714             throw new rating_exception('notmemberofgroup');
1715         }
1716     }
1718     return true;
1721 /**
1722  * Can the current user see ratings for a given itemid?
1723  *
1724  * @param array $params submitted data
1725  *            contextid => int contextid [required]
1726  *            component => The component for this module - should always be mod_data [required]
1727  *            ratingarea => object the context in which the rated items exists [required]
1728  *            itemid => int the ID of the object being rated [required]
1729  *            scaleid => int scale id [optional]
1730  * @return bool
1731  * @throws coding_exception
1732  * @throws rating_exception
1733  */
1734 function mod_data_rating_can_see_item_ratings($params) {
1735     global $DB;
1737     // Check the component is mod_data.
1738     if (!isset($params['component']) || $params['component'] != 'mod_data') {
1739         throw new rating_exception('invalidcomponent');
1740     }
1742     // Check the ratingarea is entry (the only rating area in data).
1743     if (!isset($params['ratingarea']) || $params['ratingarea'] != 'entry') {
1744         throw new rating_exception('invalidratingarea');
1745     }
1747     if (!isset($params['itemid'])) {
1748         throw new rating_exception('invaliditemid');
1749     }
1751     $datasql = "SELECT d.id as dataid, d.course, r.groupid
1752                   FROM {data_records} r
1753                   JOIN {data} d ON r.dataid = d.id
1754                  WHERE r.id = :itemid";
1755     $dataparams = array('itemid' => $params['itemid']);
1756     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1757         // Item doesn't exist.
1758         throw new rating_exception('invaliditemid');
1759     }
1761     // User can see ratings of all participants.
1762     if ($info->groupid == 0) {
1763         return true;
1764     }
1766     $course = $DB->get_record('course', array('id' => $info->course), '*', MUST_EXIST);
1767     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1769     // Make sure groups allow this user to see the item they're rating.
1770     return groups_group_visible($info->groupid, $course, $cm);
1774 /**
1775  * function that takes in the current data, number of items per page,
1776  * a search string and prints a preference box in view.php
1777  *
1778  * This preference box prints a searchable advanced search template if
1779  *     a) A template is defined
1780  *  b) The advanced search checkbox is checked.
1781  *
1782  * @global object
1783  * @global object
1784  * @param object $data
1785  * @param int $perpage
1786  * @param string $search
1787  * @param string $sort
1788  * @param string $order
1789  * @param array $search_array
1790  * @param int $advanced
1791  * @param string $mode
1792  * @return void
1793  */
1794 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1795     global $CFG, $DB, $PAGE, $OUTPUT;
1797     $cm = get_coursemodule_from_instance('data', $data->id);
1798     $context = context_module::instance($cm->id);
1799     echo '<br /><div class="datapreferences">';
1800     echo '<form id="options" action="view.php" method="get">';
1801     echo '<div>';
1802     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1803     if ($mode =='asearch') {
1804         $advanced = 1;
1805         echo '<input type="hidden" name="mode" value="list" />';
1806     }
1807     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1808     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1809                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1810     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id' => 'pref_perpage', 'class' => 'custom-select'));
1812     if ($advanced) {
1813         $regsearchclass = 'search_none';
1814         $advancedsearchclass = 'search_inline';
1815     } else {
1816         $regsearchclass = 'search_inline';
1817         $advancedsearchclass = 'search_none';
1818     }
1819     echo '<div id="reg_search" class="' . $regsearchclass . ' form-inline" >&nbsp;&nbsp;&nbsp;';
1820     echo '<label for="pref_search">' . get_string('search') . '</label> <input type="text" ' .
1821          'class="form-control" size="16" name="search" id= "pref_search" value="' . s($search) . '" /></div>';
1822     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1823     // foreach field, print the option
1824     echo '<select name="sort" id="pref_sortby" class="custom-select mr-1">';
1825     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1826         echo '<optgroup label="'.get_string('fields', 'data').'">';
1827         foreach ($fields as $field) {
1828             if ($field->id == $sort) {
1829                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1830             } else {
1831                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1832             }
1833         }
1834         echo '</optgroup>';
1835     }
1836     $options = array();
1837     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1838     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1839     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1840     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1841     if ($data->approval and has_capability('mod/data:approve', $context)) {
1842         $options[DATA_APPROVED] = get_string('approved', 'data');
1843     }
1844     echo '<optgroup label="'.get_string('other', 'data').'">';
1845     foreach ($options as $key => $name) {
1846         if ($key == $sort) {
1847             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1848         } else {
1849             echo '<option value="'.$key.'">'.$name.'</option>';
1850         }
1851     }
1852     echo '</optgroup>';
1853     echo '</select>';
1854     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1855     echo '<select id="pref_order" name="order" class="custom-select mr-1">';
1856     if ($order == 'ASC') {
1857         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1858     } else {
1859         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1860     }
1861     if ($order == 'DESC') {
1862         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1863     } else {
1864         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1865     }
1866     echo '</select>';
1868     if ($advanced) {
1869         $checked = ' checked="checked" ';
1870     }
1871     else {
1872         $checked = '';
1873     }
1874     $PAGE->requires->js('/mod/data/data.js');
1875     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1876     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1877     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" ' . $checked . ' ' .
1878          'onchange="showHideAdvSearch(this.checked);" class="mx-1" />' .
1879          '<label for="advancedcheckbox">' . get_string('advancedsearch', 'data') . '</label>';
1880     echo '&nbsp;<input type="submit" class="btn btn-secondary" value="' . get_string('savesettings', 'data') . '" />';
1882     echo '<br />';
1883     echo '<div class="' . $advancedsearchclass . '" id="data_adv_form">';
1884     echo '<table class="boxaligncenter">';
1886     // print ASC or DESC
1887     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1888     $i = 0;
1890     // Determine if we are printing all fields for advanced search, or the template for advanced search
1891     // If a template is not defined, use the deafault template and display all fields.
1892     if(empty($data->asearchtemplate)) {
1893         data_generate_default_template($data, 'asearchtemplate');
1894     }
1896     static $fields = array();
1897     static $dataid = null;
1899     if (empty($dataid)) {
1900         $dataid = $data->id;
1901     } else if ($dataid != $data->id) {
1902         $fields = array();
1903     }
1905     if (empty($fields)) {
1906         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1907         foreach ($fieldrecords as $fieldrecord) {
1908             $fields[]= data_get_field($fieldrecord, $data);
1909         }
1910     }
1912     // Replacing tags
1913     $patterns = array();
1914     $replacement = array();
1916     // Then we generate strings to replace for normal tags
1917     foreach ($fields as $field) {
1918         $fieldname = $field->field->name;
1919         $fieldname = preg_quote($fieldname, '/');
1920         $patterns[] = "/\[\[$fieldname\]\]/i";
1921         $searchfield = data_get_field_from_id($field->field->id, $data);
1922         if (!empty($search_array[$field->field->id]->data)) {
1923             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1924         } else {
1925             $replacement[] = $searchfield->display_search_field();
1926         }
1927     }
1928     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1929     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1930     $patterns[]    = '/##firstname##/';
1931     $replacement[] = '<label class="accesshide" for="u_fn">' . get_string('authorfirstname', 'data') . '</label>' .
1932                      '<input type="text" class="form-control" size="16" id="u_fn" name="u_fn" value="' . s($fn) . '" />';
1933     $patterns[]    = '/##lastname##/';
1934     $replacement[] = '<label class="accesshide" for="u_ln">' . get_string('authorlastname', 'data') . '</label>' .
1935                      '<input type="text" class="form-control" size="16" id="u_ln" name="u_ln" value="' . s($ln) . '" />';
1937     if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
1938         $patterns[] = "/##tags##/";
1939         $selectedtags = isset($search_array[DATA_TAGS]->rawtagnames) ? $search_array[DATA_TAGS]->rawtagnames : [];
1940         $replacement[] = data_generate_tag_form(false, $selectedtags);
1941     }
1943     // actual replacement of the tags
1945     $options = new stdClass();
1946     $options->para=false;
1947     $options->noclean=true;
1948     echo '<tr><td>';
1949     echo preg_replace($patterns, $replacement, format_text($data->asearchtemplate, FORMAT_HTML, $options));
1950     echo '</td></tr>';
1952     echo '<tr><td colspan="4"><br/>' .
1953          '<input type="submit" class="btn btn-primary mr-1" value="' . get_string('savesettings', 'data') . '" />' .
1954          '<input type="submit" class="btn btn-secondary" name="resetadv" value="' . get_string('resetsettings', 'data') . '" />' .
1955          '</td></tr>';
1956     echo '</table>';
1957     echo '</div>';
1958     echo '</div>';
1959     echo '</form>';
1960     echo '</div>';
1963 /**
1964  * @global object
1965  * @global object
1966  * @param object $data
1967  * @param object $record
1968  * @return void Output echo'd
1969  */
1970 function data_print_ratings($data, $record) {
1971     global $OUTPUT;
1972     if (!empty($record->rating)){
1973         echo $OUTPUT->render($record->rating);
1974     }
1977 /**
1978  * List the actions that correspond to a view of this module.
1979  * This is used by the participation report.
1980  *
1981  * Note: This is not used by new logging system. Event with
1982  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1983  *       be considered as view action.
1984  *
1985  * @return array
1986  */
1987 function data_get_view_actions() {
1988     return array('view');
1991 /**
1992  * List the actions that correspond to a post of this module.
1993  * This is used by the participation report.
1994  *
1995  * Note: This is not used by new logging system. Event with
1996  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1997  *       will be considered as post action.
1998  *
1999  * @return array
2000  */
2001 function data_get_post_actions() {
2002     return array('add','update','record delete');
2005 /**
2006  * @param string $name
2007  * @param int $dataid
2008  * @param int $fieldid
2009  * @return bool
2010  */
2011 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
2012     global $DB;
2014     if (!is_numeric($name)) {
2015         $like = $DB->sql_like('df.name', ':name', false);
2016     } else {
2017         $like = "df.name = :name";
2018     }
2019     $params = array('name'=>$name);
2020     if ($fieldid) {
2021         $params['dataid']   = $dataid;
2022         $params['fieldid1'] = $fieldid;
2023         $params['fieldid2'] = $fieldid;
2024         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2025                                         WHERE $like AND df.dataid = :dataid
2026                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
2027     } else {
2028         $params['dataid']   = $dataid;
2029         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
2030                                         WHERE $like AND df.dataid = :dataid", $params);
2031     }
2034 /**
2035  * @param array $fieldinput
2036  */
2037 function data_convert_arrays_to_strings(&$fieldinput) {
2038     foreach ($fieldinput as $key => $val) {
2039         if (is_array($val)) {
2040             $str = '';
2041             foreach ($val as $inner) {
2042                 $str .= $inner . ',';
2043             }
2044             $str = substr($str, 0, -1);
2046             $fieldinput->$key = $str;
2047         }
2048     }
2052 /**
2053  * Converts a database (module instance) to use the Roles System
2054  *
2055  * @global object
2056  * @global object
2057  * @uses CONTEXT_MODULE
2058  * @uses CAP_PREVENT
2059  * @uses CAP_ALLOW
2060  * @param object $data a data object with the same attributes as a record
2061  *                     from the data database table
2062  * @param int $datamodid the id of the data module, from the modules table
2063  * @param array $teacherroles array of roles that have archetype teacher
2064  * @param array $studentroles array of roles that have archetype student
2065  * @param array $guestroles array of roles that have archetype guest
2066  * @param int $cmid the course_module id for this data instance
2067  * @return boolean data module was converted or not
2068  */
2069 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
2070     global $CFG, $DB, $OUTPUT;
2072     if (!isset($data->participants) && !isset($data->assesspublic)
2073             && !isset($data->groupmode)) {
2074         // We assume that this database has already been converted to use the
2075         // Roles System. above fields get dropped the data module has been
2076         // upgraded to use Roles.
2077         return false;
2078     }
2080     if (empty($cmid)) {
2081         // We were not given the course_module id. Try to find it.
2082         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
2083             echo $OUTPUT->notification('Could not get the course module for the data');
2084             return false;
2085         } else {
2086             $cmid = $cm->id;
2087         }
2088     }
2089     $context = context_module::instance($cmid);
2092     // $data->participants:
2093     // 1 - Only teachers can add entries
2094     // 3 - Teachers and students can add entries
2095     switch ($data->participants) {
2096         case 1:
2097             foreach ($studentroles as $studentrole) {
2098                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
2099             }
2100             foreach ($teacherroles as $teacherrole) {
2101                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2102             }
2103             break;
2104         case 3:
2105             foreach ($studentroles as $studentrole) {
2106                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
2107             }
2108             foreach ($teacherroles as $teacherrole) {
2109                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
2110             }
2111             break;
2112     }
2114     // $data->assessed:
2115     // 2 - Only teachers can rate posts
2116     // 1 - Everyone can rate posts
2117     // 0 - No one can rate posts
2118     switch ($data->assessed) {
2119         case 0:
2120             foreach ($studentroles as $studentrole) {
2121                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2122             }
2123             foreach ($teacherroles as $teacherrole) {
2124                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
2125             }
2126             break;
2127         case 1:
2128             foreach ($studentroles as $studentrole) {
2129                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
2130             }
2131             foreach ($teacherroles as $teacherrole) {
2132                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2133             }
2134             break;
2135         case 2:
2136             foreach ($studentroles as $studentrole) {
2137                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
2138             }
2139             foreach ($teacherroles as $teacherrole) {
2140                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
2141             }
2142             break;
2143     }
2145     // $data->assesspublic:
2146     // 0 - Students can only see their own ratings
2147     // 1 - Students can see everyone's ratings
2148     switch ($data->assesspublic) {
2149         case 0:
2150             foreach ($studentroles as $studentrole) {
2151                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
2152             }
2153             foreach ($teacherroles as $teacherrole) {
2154                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2155             }
2156             break;
2157         case 1:
2158             foreach ($studentroles as $studentrole) {
2159                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
2160             }
2161             foreach ($teacherroles as $teacherrole) {
2162                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
2163             }
2164             break;
2165     }
2167     if (empty($cm)) {
2168         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
2169     }
2171     switch ($cm->groupmode) {
2172         case NOGROUPS:
2173             break;
2174         case SEPARATEGROUPS:
2175             foreach ($studentroles as $studentrole) {
2176                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
2177             }
2178             foreach ($teacherroles as $teacherrole) {
2179                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2180             }
2181             break;
2182         case VISIBLEGROUPS:
2183             foreach ($studentroles as $studentrole) {
2184                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
2185             }
2186             foreach ($teacherroles as $teacherrole) {
2187                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
2188             }
2189             break;
2190     }
2191     return true;
2194 /**
2195  * Returns the best name to show for a preset
2196  *
2197  * @param string $shortname
2198  * @param  string $path
2199  * @return string
2200  */
2201 function data_preset_name($shortname, $path) {
2203     // We are looking inside the preset itself as a first choice, but also in normal data directory
2204     $string = get_string('modulename', 'datapreset_'.$shortname);
2206     if (substr($string, 0, 1) == '[') {
2207         return $shortname;
2208     } else {
2209         return $string;
2210     }
2213 /**
2214  * Returns an array of all the available presets.
2215  *
2216  * @return array
2217  */
2218 function data_get_available_presets($context) {
2219     global $CFG, $USER;
2221     $presets = array();
2223     // First load the ratings sub plugins that exist within the modules preset dir
2224     if ($dirs = core_component::get_plugin_list('datapreset')) {
2225         foreach ($dirs as $dir=>$fulldir) {
2226             if (is_directory_a_preset($fulldir)) {
2227                 $preset = new stdClass();
2228                 $preset->path = $fulldir;
2229                 $preset->userid = 0;
2230                 $preset->shortname = $dir;
2231                 $preset->name = data_preset_name($dir, $fulldir);
2232                 if (file_exists($fulldir.'/screenshot.jpg')) {
2233                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
2234                 } else if (file_exists($fulldir.'/screenshot.png')) {
2235                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
2236                 } else if (file_exists($fulldir.'/screenshot.gif')) {
2237                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
2238                 }
2239                 $presets[] = $preset;
2240             }
2241         }
2242     }
2243     // Now add to that the site presets that people have saved
2244     $presets = data_get_available_site_presets($context, $presets);
2245     return $presets;
2248 /**
2249  * Gets an array of all of the presets that users have saved to the site.
2250  *
2251  * @param stdClass $context The context that we are looking from.
2252  * @param array $presets
2253  * @return array An array of presets
2254  */
2255 function data_get_available_site_presets($context, array $presets=array()) {
2256     global $USER;
2258     $fs = get_file_storage();
2259     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2260     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
2261     if (empty($files)) {
2262         return $presets;
2263     }
2264     foreach ($files as $file) {
2265         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
2266             continue;
2267         }
2268         $preset = new stdClass;
2269         $preset->path = $file->get_filepath();
2270         $preset->name = trim($preset->path, '/');
2271         $preset->shortname = $preset->name;
2272         $preset->userid = $file->get_userid();
2273         $preset->id = $file->get_id();
2274         $preset->storedfile = $file;
2275         $presets[] = $preset;
2276     }
2277     return $presets;
2280 /**
2281  * Deletes a saved preset.
2282  *
2283  * @param string $name
2284  * @return bool
2285  */
2286 function data_delete_site_preset($name) {
2287     $fs = get_file_storage();
2289     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
2290     if (!empty($files)) {
2291         foreach ($files as $file) {
2292             $file->delete();
2293         }
2294     }
2296     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
2297     if (!empty($dir)) {
2298         $dir->delete();
2299     }
2300     return true;
2303 /**
2304  * Prints the heads for a page
2305  *
2306  * @param stdClass $course
2307  * @param stdClass $cm
2308  * @param stdClass $data
2309  * @param string $currenttab
2310  */
2311 function data_print_header($course, $cm, $data, $currenttab='') {
2313     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
2315     $PAGE->set_title($data->name);
2316     echo $OUTPUT->header();
2317     echo $OUTPUT->heading(format_string($data->name), 2);
2318     echo $OUTPUT->box(format_module_intro('data', $data, $cm->id), 'generalbox', 'intro');
2320     // Groups needed for Add entry tab
2321     $currentgroup = groups_get_activity_group($cm);
2322     $groupmode = groups_get_activity_groupmode($cm);
2324     // Print the tabs
2326     if ($currenttab) {
2327         include('tabs.php');
2328     }
2330     // Print any notices
2332     if (!empty($displaynoticegood)) {
2333         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
2334     } else if (!empty($displaynoticebad)) {
2335         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
2336     }
2339 /**
2340  * Can user add more entries?
2341  *
2342  * @param object $data
2343  * @param mixed $currentgroup
2344  * @param int $groupmode
2345  * @param stdClass $context
2346  * @return bool
2347  */
2348 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2349     global $USER;
2351     if (empty($context)) {
2352         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2353         $context = context_module::instance($cm->id);
2354     }
2356     if (has_capability('mod/data:manageentries', $context)) {
2357         // no entry limits apply if user can manage
2359     } else if (!has_capability('mod/data:writeentry', $context)) {
2360         return false;
2362     } else if (data_atmaxentries($data)) {
2363         return false;
2364     } else if (data_in_readonly_period($data)) {
2365         // Check whether we're in a read-only period
2366         return false;
2367     }
2369     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2370         return true;
2371     }
2373     if ($currentgroup) {
2374         return groups_is_member($currentgroup);
2375     } else {
2376         //else it might be group 0 in visible mode
2377         if ($groupmode == VISIBLEGROUPS){
2378             return true;
2379         } else {
2380             return false;
2381         }
2382     }
2385 /**
2386  * Check whether the current user is allowed to manage the given record considering manageentries capability,
2387  * data_in_readonly_period() result, ownership (determined by data_isowner()) and manageapproved setting.
2388  * @param mixed $record record object or id
2389  * @param object $data data object
2390  * @param object $context context object
2391  * @return bool returns true if the user is allowd to edit the entry, false otherwise
2392  */
2393 function data_user_can_manage_entry($record, $data, $context) {
2394     global $DB;
2396     if (has_capability('mod/data:manageentries', $context)) {
2397         return true;
2398     }
2400     // Check whether this activity is read-only at present.
2401     $readonly = data_in_readonly_period($data);
2403     if (!$readonly) {
2404         // Get record object from db if just id given like in data_isowner.
2405         // ...done before calling data_isowner() to avoid querying db twice.
2406         if (!is_object($record)) {
2407             if (!$record = $DB->get_record('data_records', array('id' => $record))) {
2408                 return false;
2409             }
2410         }
2411         if (data_isowner($record)) {
2412             if ($data->approval && $record->approved) {
2413                 return $data->manageapproved == 1;
2414             } else {
2415                 return true;
2416             }
2417         }
2418     }
2420     return false;
2423 /**
2424  * Check whether the specified database activity is currently in a read-only period
2425  *
2426  * @param object $data
2427  * @return bool returns true if the time fields in $data indicate a read-only period; false otherwise
2428  */
2429 function data_in_readonly_period($data) {
2430     $now = time();
2431     if (!$data->timeviewfrom && !$data->timeviewto) {
2432         return false;
2433     } else if (($data->timeviewfrom && $now < $data->timeviewfrom) || ($data->timeviewto && $now > $data->timeviewto)) {
2434         return false;
2435     }
2436     return true;
2439 /**
2440  * @return bool
2441  */
2442 function is_directory_a_preset($directory) {
2443     $directory = rtrim($directory, '/\\') . '/';
2444     $status = file_exists($directory.'singletemplate.html') &&
2445               file_exists($directory.'listtemplate.html') &&
2446               file_exists($directory.'listtemplateheader.html') &&
2447               file_exists($directory.'listtemplatefooter.html') &&
2448               file_exists($directory.'addtemplate.html') &&
2449               file_exists($directory.'rsstemplate.html') &&
2450               file_exists($directory.'rsstitletemplate.html') &&
2451               file_exists($directory.'csstemplate.css') &&
2452               file_exists($directory.'jstemplate.js') &&
2453               file_exists($directory.'preset.xml');
2455     return $status;
2458 /**
2459  * Abstract class used for data preset importers
2460  */
2461 abstract class data_preset_importer {
2463     protected $course;
2464     protected $cm;
2465     protected $module;
2466     protected $directory;
2468     /**
2469      * Constructor
2470      *
2471      * @param stdClass $course
2472      * @param stdClass $cm
2473      * @param stdClass $module
2474      * @param string $directory
2475      */
2476     public function __construct($course, $cm, $module, $directory) {
2477         $this->course = $course;
2478         $this->cm = $cm;
2479         $this->module = $module;
2480         $this->directory = $directory;
2481     }
2483     /**
2484      * Returns the name of the directory the preset is located in
2485      * @return string
2486      */
2487     public function get_directory() {
2488         return basename($this->directory);
2489     }
2491     /**
2492      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2493      * @param file_storage $filestorage. should be null if using a conventional directory
2494      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2495      * @param string $dir the directory to look in. null if using the Moodle file storage
2496      * @param string $filename the name of the file we want
2497      * @return string the contents of the file or null if the file doesn't exist.
2498      */
2499     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2500         if(empty($filestorage) || empty($fileobj)) {
2501             if (substr($dir, -1)!='/') {
2502                 $dir .= '/';
2503             }
2504             if (file_exists($dir.$filename)) {
2505                 return file_get_contents($dir.$filename);
2506             } else {
2507                 return null;
2508             }
2509         } else {
2510             if ($filestorage->file_exists(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename)) {
2511                 $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2512                 return $file->get_content();
2513             } else {
2514                 return null;
2515             }
2516         }
2518     }
2519     /**
2520      * Gets the preset settings
2521      * @global moodle_database $DB
2522      * @return stdClass
2523      */
2524     public function get_preset_settings() {
2525         global $DB;
2527         $fs = $fileobj = null;
2528         if (!is_directory_a_preset($this->directory)) {
2529             //maybe the user requested a preset stored in the Moodle file storage
2531             $fs = get_file_storage();
2532             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2534             //preset name to find will be the final element of the directory
2535             $explodeddirectory = explode('/', $this->directory);
2536             $presettofind = end($explodeddirectory);
2538             //now go through the available files available and see if we can find it
2539             foreach ($files as $file) {
2540                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2541                     continue;
2542                 }
2543                 $presetname = trim($file->get_filepath(), '/');
2544                 if ($presetname==$presettofind) {
2545                     $this->directory = $presetname;
2546                     $fileobj = $file;
2547                 }
2548             }
2550             if (empty($fileobj)) {
2551                 print_error('invalidpreset', 'data', '', $this->directory);
2552             }
2553         }
2555         $allowed_settings = array(
2556             'intro',
2557             'comments',
2558             'requiredentries',
2559             'requiredentriestoview',
2560             'maxentries',
2561             'rssarticles',
2562             'approval',
2563             'defaultsortdir',
2564             'defaultsort');
2566         $result = new stdClass;
2567         $result->settings = new stdClass;
2568         $result->importfields = array();
2569         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2570         if (!$result->currentfields) {
2571             $result->currentfields = array();
2572         }
2575         /* Grab XML */
2576         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2577         $parsedxml = xmlize($presetxml, 0);
2579         /* First, do settings. Put in user friendly array. */
2580         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2581         $result->settings = new StdClass();
2582         foreach ($settingsarray as $setting => $value) {
2583             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2584                 // unsupported setting
2585                 continue;
2586             }
2587             $result->settings->$setting = $value[0]['#'];
2588         }
2590         /* Now work out fields to user friendly array */
2591         $fieldsarray = $parsedxml['preset']['#']['field'];
2592         foreach ($fieldsarray as $field) {
2593             if (!is_array($field)) {
2594                 continue;
2595             }
2596             $f = new StdClass();
2597             foreach ($field['#'] as $param => $value) {
2598                 if (!is_array($value)) {
2599                     continue;
2600                 }
2601                 $f->$param = $value[0]['#'];
2602             }
2603             $f->dataid = $this->module->id;
2604             $f->type = clean_param($f->type, PARAM_ALPHA);
2605             $result->importfields[] = $f;
2606         }
2607         /* Now add the HTML templates to the settings array so we can update d */
2608         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2609         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2610         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2611         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2612         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2613         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2614         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2615         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2616         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2617         $result->settings->asearchtemplate    = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2619         $result->settings->instance = $this->module->id;
2620         return $result;
2621     }
2623     /**
2624      * Import the preset into the given database module
2625      * @return bool
2626      */
2627     function import($overwritesettings) {
2628         global $DB, $CFG;
2630         $params = $this->get_preset_settings();
2631         $settings = $params->settings;
2632         $newfields = $params->importfields;
2633         $currentfields = $params->currentfields;
2634         $preservedfields = array();
2636         /* Maps fields and makes new ones */
2637         if (!empty($newfields)) {
2638             /* We require an injective mapping, and need to know what to protect */
2639             foreach ($newfields as $nid => $newfield) {
2640                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2641                 if ($cid == -1) {
2642                     continue;
2643                 }
2644                 if (array_key_exists($cid, $preservedfields)){
2645                     print_error('notinjectivemap', 'data');
2646                 }
2647                 else $preservedfields[$cid] = true;
2648             }
2650             foreach ($newfields as $nid => $newfield) {
2651                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2653                 /* A mapping. Just need to change field params. Data kept. */
2654                 if ($cid != -1 and isset($currentfields[$cid])) {
2655                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2656                     foreach ($newfield as $param => $value) {
2657                         if ($param != "id") {
2658                             $fieldobject->field->$param = $value;
2659                         }
2660                     }
2661                     unset($fieldobject->field->similarfield);
2662                     $fieldobject->update_field();
2663                     unset($fieldobject);
2664                 } else {
2665                     /* Make a new field */
2666                     include_once("field/$newfield->type/field.class.php");
2668                     if (!isset($newfield->description)) {
2669                         $newfield->description = '';
2670                     }
2671                     $classname = 'data_field_'.$newfield->type;
2672                     $fieldclass = new $classname($newfield, $this->module);
2673                     $fieldclass->insert_field();
2674                     unset($fieldclass);
2675                 }
2676             }
2677         }
2679         /* Get rid of all old unused data */
2680         if (!empty($preservedfields)) {
2681             foreach ($currentfields as $cid => $currentfield) {
2682                 if (!array_key_exists($cid, $preservedfields)) {
2683                     /* Data not used anymore so wipe! */
2684                     print "Deleting field $currentfield->name<br />";
2686                     $id = $currentfield->id;
2687                     //Why delete existing data records and related comments/ratings??
2688                     $DB->delete_records('data_content', array('fieldid'=>$id));
2689                     $DB->delete_records('data_fields', array('id'=>$id));
2690                 }
2691             }
2692         }
2694         // handle special settings here
2695         if (!empty($settings->defaultsort)) {
2696             if (is_numeric($settings->defaultsort)) {
2697                 // old broken value
2698                 $settings->defaultsort = 0;
2699             } else {
2700                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2701             }
2702         } else {
2703             $settings->defaultsort = 0;
2704         }
2706         // do we want to overwrite all current database settings?
2707         if ($overwritesettings) {
2708             // all supported settings
2709             $overwrite = array_keys((array)$settings);
2710         } else {
2711             // only templates and sorting
2712             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2713                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2714                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2715         }
2717         // now overwrite current data settings
2718         foreach ($this->module as $prop=>$unused) {
2719             if (in_array($prop, $overwrite)) {
2720                 $this->module->$prop = $settings->$prop;
2721             }
2722         }
2724         data_update_instance($this->module);
2726         return $this->cleanup();
2727     }
2729     /**
2730      * Any clean up routines should go here
2731      * @return bool
2732      */
2733     public function cleanup() {
2734         return true;
2735     }
2738 /**
2739  * Data preset importer for uploaded presets
2740  */
2741 class data_preset_upload_importer extends data_preset_importer {
2742     public function __construct($course, $cm, $module, $filepath) {
2743         global $USER;
2744         if (is_file($filepath)) {
2745             $fp = get_file_packer();
2746             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2747                 fulldelete($filepath);
2748             }
2749             $filepath .= '_extracted';
2750         }
2751         parent::__construct($course, $cm, $module, $filepath);
2752     }
2753     public function cleanup() {
2754         return fulldelete($this->directory);
2755     }
2758 /**
2759  * Data preset importer for existing presets
2760  */
2761 class data_preset_existing_importer extends data_preset_importer {
2762     protected $userid;
2763     public function __construct($course, $cm, $module, $fullname) {
2764         global $USER;
2765         list($userid, $shortname) = explode('/', $fullname, 2);
2766         $context = context_module::instance($cm->id);
2767         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2768            throw new coding_exception('Invalid preset provided');
2769         }
2771         $this->userid = $userid;
2772         $filepath = data_preset_path($course, $userid, $shortname);
2773         parent::__construct($course, $cm, $module, $filepath);
2774     }
2775     public function get_userid() {
2776         return $this->userid;
2777     }
2780 /**
2781  * @global object
2782  * @global object
2783  * @param object $course
2784  * @param int $userid
2785  * @param string $shortname
2786  * @return string
2787  */
2788 function data_preset_path($course, $userid, $shortname) {
2789     global $USER, $CFG;
2791     $context = context_course::instance($course->id);
2793     $userid = (int)$userid;
2795     $path = null;
2796     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2797         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2798     } else if ($userid == 0) {
2799         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2800     } else if ($userid < 0) {
2801         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2802     }
2804     return $path;
2807 /**
2808  * Implementation of the function for printing the form elements that control
2809  * whether the course reset functionality affects the data.
2810  *
2811  * @param $mform form passed by reference
2812  */
2813 function data_reset_course_form_definition(&$mform) {
2814     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2815     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2817     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2818     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2820     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2821     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2823     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2824     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2826     $mform->addElement('checkbox', 'reset_data_tags', get_string('removealldatatags', 'data'));
2827     $mform->disabledIf('reset_data_tags', 'reset_data', 'checked');
2830 /**
2831  * Course reset form defaults.
2832  * @return array
2833  */
2834 function data_reset_course_form_defaults($course) {
2835     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2838 /**
2839  * Removes all grades from gradebook
2840  *
2841  * @global object
2842  * @global object
2843  * @param int $courseid
2844  * @param string $type optional type
2845  */
2846 function data_reset_gradebook($courseid, $type='') {
2847     global $CFG, $DB;
2849     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2850               FROM {data} d, {course_modules} cm, {modules} m
2851              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2853     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2854         foreach ($datas as $data) {
2855             data_grade_item_update($data, 'reset');
2856         }
2857     }
2860 /**
2861  * Actual implementation of the reset course functionality, delete all the
2862  * data responses for course $data->courseid.
2863  *
2864  * @global object
2865  * @global object
2866  * @param object $data the data submitted from the reset course.
2867  * @return array status array
2868  */
2869 function data_reset_userdata($data) {
2870     global $CFG, $DB;
2871     require_once($CFG->libdir.'/filelib.php');
2872     require_once($CFG->dirroot.'/rating/lib.php');
2874     $componentstr = get_string('modulenameplural', 'data');
2875     $status = array();
2877     $allrecordssql = "SELECT r.id
2878                         FROM {data_records} r
2879                              INNER JOIN {data} d ON r.dataid = d.id
2880                        WHERE d.course = ?";
2882     $alldatassql = "SELECT d.id
2883                       FROM {data} d
2884                      WHERE d.course=?";
2886     $rm = new rating_manager();
2887     $ratingdeloptions = new stdClass;
2888     $ratingdeloptions->component = 'mod_data';
2889     $ratingdeloptions->ratingarea = 'entry';
2891     // Set the file storage - may need it to remove files later.
2892     $fs = get_file_storage();
2894     // delete entries if requested
2895     if (!empty($data->reset_data)) {
2896         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2897         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2898         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2900         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2901             foreach ($datas as $dataid=>$unused) {
2902                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2903                     continue;
2904                 }
2905                 $datacontext = context_module::instance($cm->id);
2907                 // Delete any files that may exist.
2908                 $fs->delete_area_files($datacontext->id, 'mod_data', 'content');
2910                 $ratingdeloptions->contextid = $datacontext->id;
2911                 $rm->delete_ratings($ratingdeloptions);
2913                 core_tag_tag::delete_instances('mod_data', null, $datacontext->id);
2914             }
2915         }
2917         if (empty($data->reset_gradebook_grades)) {
2918             // remove all grades from gradebook
2919             data_reset_gradebook($data->courseid);
2920         }
2921         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2922     }
2924     // remove entries by users not enrolled into course
2925     if (!empty($data->reset_data_notenrolled)) {
2926         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2927                          FROM {data_records} r
2928                               JOIN {data} d ON r.dataid = d.id
2929                               LEFT JOIN {user} u ON r.userid = u.id
2930                         WHERE d.course = ? AND r.userid > 0";
2932         $course_context = context_course::instance($data->courseid);
2933         $notenrolled = array();
2934         $fields = array();
2935         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2936         foreach ($rs as $record) {
2937             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2938               or !is_enrolled($course_context, $record->userid)) {
2939                 //delete ratings
2940                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2941                     continue;
2942                 }
2943                 $datacontext = context_module::instance($cm->id);
2944                 $ratingdeloptions->contextid = $datacontext->id;
2945                 $ratingdeloptions->itemid = $record->id;
2946                 $rm->delete_ratings($ratingdeloptions);
2948                 // Delete any files that may exist.
2949                 if ($contents = $DB->get_records('data_content', array('recordid' => $record->id), '', 'id')) {
2950                     foreach ($contents as $content) {
2951                         $fs->delete_area_files($datacontext->id, 'mod_data', 'content', $content->id);
2952                     }
2953                 }
2954                 $notenrolled[$record->userid] = true;
2956                 core_tag_tag::remove_all_item_tags('mod_data', 'data_records', $record->id);
2958                 $DB->delete_records('comments', array('itemid' => $record->id, 'commentarea' => 'database_entry'));
2959                 $DB->delete_records('data_content', array('recordid' => $record->id));
2960                 $DB->delete_records('data_records', array('id' => $record->id));
2961             }
2962         }
2963         $rs->close();
2964         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2965     }
2967     // remove all ratings
2968     if (!empty($data->reset_data_ratings)) {
2969         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2970             foreach ($datas as $dataid=>$unused) {
2971                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2972                     continue;
2973                 }
2974                 $datacontext = context_module::instance($cm->id);
2976                 $ratingdeloptions->contextid = $datacontext->id;
2977                 $rm->delete_ratings($ratingdeloptions);
2978             }
2979         }
2981         if (empty($data->reset_gradebook_grades)) {
2982             // remove all grades from gradebook
2983             data_reset_gradebook($data->courseid);
2984         }
2986         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2987     }
2989     // remove all comments
2990     if (!empty($data->reset_data_comments)) {
2991         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2992         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2993     }
2995     // Remove all the tags.
2996     if (!empty($data->reset_data_tags)) {
2997         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2998             foreach ($datas as $dataid => $unused) {
2999                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
3000                     continue;
3001                 }
3003                 $context = context_module::instance($cm->id);
3004                 core_tag_tag::delete_instances('mod_data', null, $context->id);
3006             }
3007         }
3008         $status[] = array('component' => $componentstr, 'item' => get_string('tagsdeleted', 'data'), 'error' => false);
3009     }
3011     // updating dates - shift may be negative too
3012     if ($data->timeshift) {
3013         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
3014         // See MDL-9367.
3015         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto',
3016             'timeviewfrom', 'timeviewto', 'assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
3017         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3018     }
3020     return $status;
3023 /**
3024  * Returns all other caps used in module
3025  *
3026  * @return array
3027  */
3028 function data_get_extra_capabilities() {
3029     return ['moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate',
3030             'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete'];
3033 /**
3034  * @param string $feature FEATURE_xx constant for requested feature
3035  * @return mixed True if module supports feature, null if doesn't know
3036  */
3037 function data_supports($feature) {
3038     switch($feature) {
3039         case FEATURE_GROUPS:                  return true;
3040         case FEATURE_GROUPINGS:               return true;
3041         case FEATURE_MOD_INTRO:               return true;
3042         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
3043         case FEATURE_COMPLETION_HAS_RULES:    return true;
3044         case FEATURE_GRADE_HAS_GRADE:         return true;
3045         case FEATURE_GRADE_OUTCOMES:          return true;
3046         case FEATURE_RATE:                    return true;
3047         case FEATURE_BACKUP_MOODLE2:          return true;
3048         case FEATURE_SHOW_DESCRIPTION:        return true;
3049         case FEATURE_COMMENT:                 return true;
3051         default: return null;
3052     }
3054 /**
3055  * @global object
3056  * @param array $export
3057  * @param string $delimiter_name
3058  * @param object $database
3059  * @param int $count
3060  * @param bool $return
3061  * @return string|void
3062  */
3063 function data_export_csv($export, $delimiter_name, $database, $count, $return=false) {
3064     global $CFG;
3065     require_once($CFG->libdir . '/csvlib.class.php');
3067     $filename = $database . '-' . $count . '-record';
3068     if ($count > 1) {
3069         $filename .= 's';
3070     }
3071     if ($return) {
3072         return csv_export_writer::print_array($export, $delimiter_name, '"', true);
3073     } else {
3074         csv_export_writer::download_array($filename, $export, $delimiter_name);
3075     }
3078 /**
3079  * @global object
3080  * @param array $export
3081  * @param string $dataname
3082  * @param int $count
3083  * @return string
3084  */
3085 function data_export_xls($export, $dataname, $count) {
3086     global $CFG;
3087     require_once("$CFG->libdir/excellib.class.php");
3088     $filename = clean_filename("{$dataname}-{$count}_record");
3089     if ($count > 1) {
3090         $filename .= 's';
3091     }
3092     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3093     $filename .= '.xls';
3095     $filearg = '-';
3096     $workbook = new MoodleExcelWorkbook($filearg);
3097     $workbook->send($filename);
3098     $worksheet = array();
3099     $worksheet[0] = $workbook->add_worksheet('');
3100     $rowno = 0;
3101     foreach ($export as $row) {
3102         $colno = 0;
3103         foreach($row as $col) {
3104             $worksheet[0]->write($rowno, $colno, $col);
3105             $colno++;
3106         }
3107         $rowno++;
3108     }
3109     $workbook->close();
3110     return $filename;
3113 /**
3114  * @global object
3115  * @param array $export
3116  * @param string $dataname
3117  * @param int $count
3118  * @param string
3119  */
3120 function data_export_ods($export, $dataname, $count) {
3121     global $CFG;
3122     require_once("$CFG->libdir/odslib.class.php");
3123     $filename = clean_filename("{$dataname}-{$count}_record");
3124     if ($count > 1) {
3125         $filename .= 's';
3126     }
3127     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
3128     $filename .= '.ods';
3129     $filearg = '-';
3130     $workbook = new MoodleODSWorkbook($filearg);
3131     $workbook->send($filename);
3132     $worksheet = array();
3133     $worksheet[0] = $workbook->add_worksheet('');
3134     $rowno = 0;
3135     foreach ($export as $row) {
3136         $colno = 0;
3137         foreach($row as $col) {
3138             $worksheet[0]->write($rowno, $colno, $col);
3139             $colno++;
3140         }
3141         $rowno++;
3142     }
3143     $workbook->close();
3144     return $filename;
3147 /**
3148  * @global object
3149  * @param int $dataid
3150  * @param array $fields
3151  * @param array $selectedfields
3152  * @param int $currentgroup group ID of the current group. This is used for
3153  * exporting data while maintaining group divisions.
3154  * @param object $context the context in which the operation is performed (for capability checks)
3155  * @param bool $userdetails whether to include the details of the record author
3156  * @param bool $time whether to include time created/modified
3157  * @param bool $approval whether to include approval status
3158  * @param bool $tags whether to include tags
3159  * @return array
3160  */
3161 function data_get_exportdata($dataid, $fields, $selectedfields, $currentgroup=0, $context=null,
3162                              $userdetails=false, $time=false, $approval=false, $tags = false) {
3163     global $DB;
3165     if (is_null($context)) {
3166         $context = context_system::instance();
3167     }
3168     // exporting user data needs special permission
3169     $userdetails = $userdetails && has_capability('mod/data:exportuserinfo', $context);
3171     $exportdata = array();
3173     // populate the header in first row of export
3174     foreach($fields as $key => $field) {
3175         if (!in_array($field->field->id, $selectedfields)) {
3176             // ignore values we aren't exporting
3177             unset($fields[$key]);
3178         } else {
3179             $exportdata[0][] = $field->field->name;
3180         }
3181     }
3182     if ($tags) {
3183         $exportdata[0][] = get_string('tags', 'data');
3184     }
3185     if ($userdetails) {
3186         $exportdata[0][] = get_string('user');
3187         $exportdata[0][] = get_string('username');
3188         $exportdata[0][] = get_string('email');
3189     }
3190     if ($time) {
3191         $exportdata[0][] = get_string('timeadded', 'data');
3192         $exportdata[0][] = get_string('timemodified', 'data');
3193     }
3194     if ($approval) {
3195         $exportdata[0][] = get_string('approved', 'data');
3196     }
3198     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
3199     ksort($datarecords);
3200     $line = 1;
3201     foreach($datarecords as $record) {
3202         // get content indexed by fieldid
3203         if ($currentgroup) {
3204             $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 = ?';
3205             $where = array($record->id, $currentgroup);
3206         } else {
3207             $select = 'SELECT fieldid, content, content1, content2, content3, content4 FROM {data_content} WHERE recordid = ?';
3208             $where = array($record->id);
3209         }
3211         if( $content = $DB->get_records_sql($select, $where) ) {
3212             foreach($fields as $field) {
3213                 $contents = '';
3214                 if(isset($content[$field->field->id])) {
3215                     $contents = $field->export_text_value($content[$field->field->id]);
3216                 }
3217                 $exportdata[$line][] = $contents;
3218             }
3219             if ($tags) {
3220                 $itemtags = \core_tag_tag::get_item_tags_array('mod_data', 'data_records', $record->id);
3221                 $exportdata[$line][] = implode(', ', $itemtags);
3222             }
3223             if ($userdetails) { // Add user details to the export data
3224                 $userdata = get_complete_user_data('id', $record->userid);
3225                 $exportdata[$line][] = fullname($userdata);
3226                 $exportdata[$line][] = $userdata->username;
3227                 $exportdata[$line][] = $userdata->email;
3228             }
3229             if ($time) { // Add time added / modified
3230                 $exportdata[$line][] = userdate($record->timecreated);
3231                 $exportdata[$line][] = userdate($record->timemodified);
3232             }
3233             if ($approval) { // Add approval status
3234                 $exportdata[$line][] = (int) $record->approved;
3235             }
3236         }
3237         $line++;
3238     }
3239     $line--;
3240     return $exportdata;
3243 ////////////////////////////////////////////////////////////////////////////////
3244 // File API                                                                   //
3245 ////////////////////////////////////////////////////////////////////////////////
3247 /**
3248  * Lists all browsable file areas
3249  *
3250  * @package  mod_data
3251  * @category files
3252  * @param stdClass $course course object
3253  * @param stdClass $cm course module object
3254  * @param stdClass $context context object
3255  * @return array
3256  */
3257 function data_get_file_areas($course, $cm, $context) {
3258     return array('content' => get_string('areacontent', 'mod_data'));
3261 /**
3262  * File browsing support for data module.
3263  *
3264  * @param file_browser $browser
3265  * @param array $areas
3266  * @param stdClass $course
3267  * @param cm_info $cm
3268  * @param context $context
3269  * @param string $filearea
3270  * @param int $itemid
3271  * @param string $filepath
3272  * @param string $filename
3273  * @return file_info_stored file_info_stored instance or null if not found
3274  */
3275 function data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
3276     global $CFG, $DB, $USER;
3278     if ($context->contextlevel != CONTEXT_MODULE) {
3279         return null;
3280     }
3282     if (!isset($areas[$filearea])) {
3283         return null;
3284     }
3286     if (is_null($itemid)) {
3287         require_once($CFG->dirroot.'/mod/data/locallib.php');
3288         return new data_file_info_container($browser, $course, $cm, $context, $areas, $filearea);
3289     }
3291     if (!$content = $DB->get_record('data_content', array('id'=>$itemid))) {
3292         return null;
3293     }
3295     if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3296         return null;
3297     }
3299     if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3300         return null;
3301     }
3303     if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3304         return null;
3305     }
3307     //check if approved
3308     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3309         return null;
3310     }
3312     // group access
3313     if ($record->groupid) {
3314         $groupmode = groups_get_activity_groupmode($cm, $course);
3315         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3316             if (!groups_is_member($record->groupid)) {
3317                 return null;
3318             }
3319         }
3320     }
3322     $fieldobj = data_get_field($field, $data, $cm);
3324     $filepath = is_null($filepath) ? '/' : $filepath;
3325     $filename = is_null($filename) ? '.' : $filename;
3326     if (!$fieldobj->file_ok($filepath.$filename)) {
3327         return null;
3328     }
3330     $fs = get_file_storage();
3331     if (!($storedfile = $fs->get_file($context->id, 'mod_data', $filearea, $itemid, $filepath, $filename))) {
3332         return null;
3333     }
3335     // Checks to see if the user can manage files or is the owner.
3336     // TODO MDL-33805 - Do not use userid here and move the capability check above.
3337     if (!has_capability('moodle/course:managefiles', $context) && $storedfile->get_userid() != $USER->id) {
3338         return null;
3339     }
3341     $urlbase = $CFG->wwwroot.'/pluginfile.php';
3343     return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
3346 /**
3347  * Serves the data attachments. Implements needed access control ;-)
3348  *
3349  * @package  mod_data
3350  * @category files
3351  * @param stdClass $course course object
3352  * @param stdClass $cm course module object
3353  * @param stdClass $context context object
3354  * @param string $filearea file area
3355  * @param array $args extra arguments
3356  * @param bool $forcedownload whether or not force download
3357  * @param array $options additional options affecting the file serving
3358  * @return bool false if file not found, does not return if found - justsend the file
3359  */
3360 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
3361     global $CFG, $DB;
3363     if ($context->contextlevel != CONTEXT_MODULE) {
3364         return false;
3365     }
3367     require_course_login($course, true, $cm);
3369     if ($filearea === 'content') {
3370         $contentid = (int)array_shift($args);
3372         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
3373             return false;
3374         }
3376         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
3377             return false;
3378         }
3380         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
3381             return false;
3382         }
3384         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
3385             return false;
3386         }
3388         if ($data->id != $cm->instance) {
3389             // hacker attempt - context does not match the contentid
3390             return false;
3391         }
3393         //check if approved
3394         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3395             return false;
3396         }
3398         // group access
3399         if ($record->groupid) {
3400             $groupmode = groups_get_activity_groupmode($cm, $course);
3401             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3402                 if (!groups_is_member($record->groupid)) {
3403                     return false;
3404                 }
3405             }
3406         }
3408         $fieldobj = data_get_field($field, $data, $cm);
3410         $relativepath = implode('/', $args);
3411         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
3413         if (!$fieldobj->file_ok($relativepath)) {
3414             return false;
3415         }
3417         $fs = get_file_storage();
3418         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
3419             return false;
3420         }
3422         // finally send the file
3423         send_stored_file($file, 0, 0, true, $options); // download MUST be forced - security!
3424     }
3426     return false;
3430 function data_extend_navigation($navigation, $course, $module, $cm) {
3431     global $CFG, $OUTPUT, $USER, $DB;
3432     require_once($CFG->dirroot . '/mod/data/locallib.php');
3434     $rid = optional_param('rid', 0, PARAM_INT);
3436     $data = $DB->get_record('data', array('id'=>$cm->instance));
3437     $currentgroup = groups_get_activity_group($cm);
3438     $groupmode = groups_get_activity_groupmode($cm);
3440      $numentries = data_numentries($data);
3441     $canmanageentries = has_capability('mod/data:manageentries', context_module::instance($cm->id));
3443     if ($data->entriesleft = data_get_entries_left_to_add($data, $numentries, $canmanageentries)) {
3444         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
3445         $entriesnode->add_class('note');
3446     }
3448     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
3449     if (!empty($rid)) {
3450         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
3451     } else {
3452         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
3453     }
3454     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
3457 /**
3458  * Adds module specific settings to the settings block
3459  *
3460  * @param settings_navigation $settings The settings navigation object
3461  * @param navigation_node $datanode The node to add module settings to
3462  */
3463 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
3464     global $PAGE, $DB, $CFG, $USER;
3466     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
3468     $currentgroup = groups_get_activity_group($PAGE->cm);
3469     $groupmode = groups_get_activity_groupmode($PAGE->cm);
3471     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
3472         if (empty($editentry)) { //TODO: undefined
3473             $addstring = get_string('add', 'data');
3474         } else {
3475             $addstring = get_string('editentry', 'data');
3476         }
3477         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
3478     }
3480     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
3481         // The capability required to Export database records is centrally defined in 'lib.php'
3482         // and should be weaker than those required to edit Templates, Fields and Presets.
3483         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
3484     }
3485     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
3486         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
3487     }
3489     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
3490         $currenttab = '';
3491         if ($currenttab == 'list') {
3492             $defaultemplate = 'listtemplate';
3493         } else if ($currenttab == 'add') {
3494             $defaultemplate = 'addtemplate';
3495         } else if ($currenttab == 'asearch') {
3496             $defaultemplate = 'asearchtemplate';
3497         } else {
3498             $defaultemplate = 'singletemplate';
3499         }
3501         $templates = $datanode->add(get_string('templates', 'data'));
3503         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3504         foreach ($templatelist as $template) {
3505             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3506         }
3508         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3509         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3510     }
3512     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3513         require_once("$CFG->libdir/rsslib.php");
3515         $string = get_string('rsstype','forum');
3517         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3518         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3519     }
3522 /**
3523  * Save the database configuration as a preset.
3524  *
3525  * @param stdClass $course The course the database module belongs to.
3526  * @param stdClass $cm The course module record
3527  * @param stdClass $data The database record
3528  * @param string $path
3529  * @return bool
3530  */
3531 function data_presets_save($course, $cm, $data, $path) {
3532     global $USER;
3533     $fs = get_file_storage();
3534     $filerecord = new stdClass;
3535     $filerecord->contextid = DATA_PRESET_CONTEXT;
3536     $filerecord->component = DATA_PRESET_COMPONENT;
3537     $filerecord->filearea = DATA_PRESET_FILEAREA;
3538     $filerecord->itemid = 0;
3539     $filerecord->filepath = '/'.$path.'/';
3540     $filerecord->userid = $USER->id;
3542     $filerecord->filename = 'preset.xml';
3543     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3545     $filerecord->filename = 'singletemplate.html';
3546     $fs->create_file_from_string($filerecord, $data->singletemplate);
3548     $filerecord->filename = 'listtemplateheader.html';
3549     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3551     $filerecord->filename = 'listtemplate.html';
3552     $fs->create_file_from_string($filerecord, $data->listtemplate);
3554     $filerecord->filename = 'listtemplatefooter.html';
3555     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3557     $filerecord->filename = 'addtemplate.html';
3558     $fs->create_file_from_string($filerecord, $data->addtemplate);
3560     $filerecord->filename = 'rsstemplate.html';
3561     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3563     $filerecord->filename = 'rsstitletemplate.html';
3564     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3566     $filerecord->filename = 'csstemplate.css';
3567     $fs->create_file_from_string($filerecord, $data->csstemplate);
3569     $filerecord->filename = 'jstemplate.js';
3570     $fs->create_file_from_string($filerecord, $data->jstemplate);
3572     $filerecord->filename = 'asearchtemplate.html';
3573     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3575     return true;
3578 /**
3579  * Generates the XML for the database module provided
3580  *
3581  * @global moodle_database $DB
3582  * @param stdClass $course The course the database module belongs to.
3583  * @param stdClass $cm The course module record
3584  * @param stdClass $data The database record
3585  * @return string The XML for the preset
3586  */
3587 function data_presets_generate_xml($course, $cm, $data) {
3588     global $DB;
3590     // Assemble "preset.xml":
3591     $presetxmldata = "<preset>\n\n";
3593     // Raw settings are not preprocessed during saving of presets
3594     $raw_settings = array(
3595         'intro',
3596         'comments',
3597         'requiredentries',
3598         'requiredentriestoview',
3599         'maxentries',
3600         'rssarticles',
3601         'approval',
3602         'manageapproved',
3603         'defaultsortdir'
3604     );
3606     $presetxmldata .= "<settings>\n";
3607     // First, settings that do not require any conversion
3608     foreach ($raw_settings as $setting) {
3609         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3610     }
3612     // Now specific settings
3613     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3614         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3615     } else {
3616         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3617     }
3618     $presetxmldata .= "</settings>\n\n";
3619     // Now for the fields. Grab all that are non-empty
3620     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3621     ksort($fields);
3622     if (!empty($fields)) {
3623         foreach ($fields as $field) {
3624             $presetxmldata .= "<field>\n";
3625             foreach ($field as $key => $value) {
3626                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3627                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3628                 }
3629             }
3630             $presetxmldata .= "</field>\n\n";
3631         }
3632     }
3633     $presetxmldata .= '</preset>';
3634     return $presetxmldata;
3637 function data_presets_export($course, $cm, $data, $tostorage=false) {
3638     global $CFG, $DB;
3640     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3641     $exportsubdir = "mod_data/presetexport/$presetname";
3642     make_temp_directory($exportsubdir);
3643     $exportdir = "$CFG->tempdir/$exportsubdir";
3645     // Assemble "preset.xml":
3646     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3648     // After opening a file in write mode, close it asap
3649     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3650     fwrite($presetxmlfile, $presetxmldata);
3651     fclose($presetxmlfile);
3653     // Now write the template files
3654     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3655     fwrite($singletemplate, $data->singletemplate);
3656     fclose($singletemplate);
3658     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3659     fwrite($listtemplateheader, $data->listtemplateheader);
3660     fclose($listtemplateheader);
3662     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3663     fwrite($listtemplate, $data->listtemplate);
3664     fclose($listtemplate);
3666     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3667     fwrite($listtemplatefooter, $data->listtemplatefooter);
3668     fclose($listtemplatefooter);