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