MDL-18910 moving modedit features to modname_supports()
[moodle.git] / mod / data / lib.php
1 <?php  // $Id$
2 ///////////////////////////////////////////////////////////////////////////
3 //                                                                       //
4 // NOTICE OF COPYRIGHT                                                   //
5 //                                                                       //
6 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
7 //          http://moodle.org                                            //
8 //                                                                       //
9 // Copyright (C) 2005 Moodle Pty Ltd    http://moodle.com                //
10 //                                                                       //
11 // This program is free software; you can redistribute it and/or modify  //
12 // it under the terms of the GNU General Public License as published by  //
13 // the Free Software Foundation; either version 2 of the License, or     //
14 // (at your option) any later version.                                   //
15 //                                                                       //
16 // This program is distributed in the hope that it will be useful,       //
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
19 // GNU General Public License for more details:                          //
20 //                                                                       //
21 //          http://www.gnu.org/copyleft/gpl.html                         //
22 //                                                                       //
23 ///////////////////////////////////////////////////////////////////////////
25 require_once($CFG->libdir . '/portfoliolib.php');
27 // Some constants
28 define ('DATA_MAX_ENTRIES', 50);
29 define ('DATA_PERPAGE_SINGLE', 1);
31 define ('DATA_FIRSTNAME', -1);
32 define ('DATA_LASTNAME', -2);
33 define ('DATA_APPROVED', -3);
34 define ('DATA_TIMEADDED', 0);
35 define ('DATA_TIMEMODIFIED', -4);
37 define ('DATA_CAP_EXPORT', 'mod/data:viewalluserpresets');
38 // Users having assigned the default role "Non-editing teacher" can export database records
39 // Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
40 // In Moodle >= 2, new roles may be introduced and used instead.
42 class data_field_base {     // Base class for Database Field Types (see field/*/field.class.php)
44     var $type = 'unknown';  // Subclasses must override the type with their name
45     var $data = NULL;       // The database object that this field belongs to
46     var $field = NULL;      // The field object itself, if we know it
48     var $iconwidth = 16;    // Width of the icon for this fieldtype
49     var $iconheight = 16;   // Width of the icon for this fieldtype
51     var $cm;                // course module or cmifno
52     var $context;           // activity context
54 // Constructor function
55     function __construct($field=0, $data=0, $cm=0) {   // Field or data or both, each can be id or object
56         global $DB;
58         if (empty($field) && empty($data)) {
59             print_error('missingfield', 'data');
60         }
62         if (!empty($field)) {
63             if (is_object($field)) {
64                 $this->field = $field;  // Programmer knows what they are doing, we hope
65             } else if (!$this->field = $DB->get_record('data_fields', array('id'=>$field))) {
66                 print_error('invalidfieldid', 'data');
67             }
68             if (empty($data)) {
69                 if (!$this->data = $DB->get_record('data', array('id'=>$this->field->dataid))) {
70                     print_error('invalidid', 'data');
71                 }
72             }
73         }
75         if (empty($this->data)) {         // We need to define this properly
76             if (!empty($data)) {
77                 if (is_object($data)) {
78                     $this->data = $data;  // Programmer knows what they are doing, we hope
79                 } else if (!$this->data = $DB->get_record('data', array('id'=>$data))) {
80                     print_error('invalidid', 'data');
81                 }
82             } else {                      // No way to define it!
83                 print_error('missingdata', 'data');
84             }
85         }
87         if ($cm) {
88             $this->cm = $cm;
89         } else {
90             $this->cm = get_coursemodule_from_instance('data', $this->data->id);
91         }
93         if (empty($this->field)) {         // We need to define some default values
94             $this->define_default_field();
95         }
97         $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
98     }
101 // This field just sets up a default field object
102     function define_default_field() {
103         if (empty($this->data->id)) {
104             notify('Programmer error: dataid not defined in field class');
105         }
106         $this->field = new object;
107         $this->field->id = 0;
108         $this->field->dataid = $this->data->id;
109         $this->field->type   = $this->type;
110         $this->field->param1 = '';
111         $this->field->param2 = '';
112         $this->field->param3 = '';
113         $this->field->name = '';
114         $this->field->description = '';
116         return true;
117     }
119 // Set up the field object according to data in an object.  Now is the time to clean it!
120     function define_field($data) {
121         $this->field->type        = $this->type;
122         $this->field->dataid      = $this->data->id;
124         $this->field->name        = trim($data->name);
125         $this->field->description = trim($data->description);
127         if (isset($data->param1)) {
128             $this->field->param1 = trim($data->param1);
129         }
130         if (isset($data->param2)) {
131             $this->field->param2 = trim($data->param2);
132         }
133         if (isset($data->param3)) {
134             $this->field->param3 = trim($data->param3);
135         }
136         if (isset($data->param4)) {
137             $this->field->param4 = trim($data->param4);
138         }
139         if (isset($data->param5)) {
140             $this->field->param5 = trim($data->param5);
141         }
143         return true;
144     }
146 // Insert a new field in the database
147 // We assume the field object is already defined as $this->field
148     function insert_field() {
149         global $DB;
151         if (empty($this->field)) {
152             notify('Programmer error: Field has not been defined yet!  See define_field()');
153             return false;
154         }
156         if (!$this->field->id = $DB->insert_record('data_fields',$this->field)){
157             notify('Insertion of new field failed!');
158             return false;
159         }
160         return true;
161     }
164 // Update a field in the database
165     function update_field() {
166         global $DB;
168         if (!$DB->update_record('data_fields', $this->field)) {
169             notify('updating of new field failed!');
170             return false;
171         }
172         return true;
173     }
175 // Delete a field completely
176     function delete_field() {
177         global $DB;
179         if (!empty($this->field->id)) {
180             $this->delete_content();
181             $DB->delete_records('data_fields', array('id'=>$this->field->id));
182         }
183         return true;
184     }
186 // Print the relevant form element in the ADD template for this field
187     function display_add_field($recordid=0){
188         global $DB;
190         if ($recordid){
191             $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
192         } else {
193             $content = '';
194         }
196         // beware get_field returns false for new, empty records MDL-18567
197         if ($content===false) {
198             $content='';
199         }
201         $str = '<div title="'.s($this->field->description).'">';
202         $str .= '<input style="width:300px;" type="text" name="field_'.$this->field->id.'" id="field_'.$this->field->id.'" value="'.s($content).'" />';
203         $str .= '</div>';
205         return $str;
206     }
208 // Print the relevant form element to define the attributes for this field
209 // viewable by teachers only.
210     function display_edit_field() {
211         global $CFG, $DB;
213         if (empty($this->field)) {   // No field has been defined yet, try and make one
214             $this->define_default_field();
215         }
216         print_simple_box_start('center','80%');
218         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
219         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
220         if (empty($this->field->id)) {
221             echo '<input type="hidden" name="mode" value="add" />'."\n";
222             $savebutton = get_string('add');
223         } else {
224             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
225             echo '<input type="hidden" name="mode" value="update" />'."\n";
226             $savebutton = get_string('savechanges');
227         }
228         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
229         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
231         print_heading($this->name());
233         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
235         echo '<div class="mdl-align">';
236         echo '<input type="submit" value="'.$savebutton.'" />'."\n";
237         echo '<input type="submit" name="cancel" value="'.get_string('cancel').'" />'."\n";
238         echo '</div>';
240         echo '</form>';
242         print_simple_box_end();
243     }
245 // Display the content of the field in browse mode
246     function display_browse_field($recordid, $template) {
247         global $DB;
249         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
250             if (isset($content->content)) {
251                 $options = new object();
252                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
253                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
254                     //$content->content1 = FORMAT_HTML;
255                     $options->filter=false;
256                 }
257                 $options->para = false;
258                 $str = format_text($content->content, $content->content1, $options);
259             } else {
260                 $str = '';
261             }
262             return $str;
263         }
264         return false;
265     }
267 // Update the content of one data field in the data_content table
268     function update_content($recordid, $value, $name=''){
269         global $DB;
271         $content = new object();
272         $content->fieldid = $this->field->id;
273         $content->recordid = $recordid;
274         $content->content = clean_param($value, PARAM_NOTAGS);
276         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
277             $content->id = $oldcontent->id;
278             return $DB->update_record('data_content', $content);
279         } else {
280             return $DB->insert_record('data_content', $content);
281         }
282     }
284 // Delete all content associated with the field
285     function delete_content($recordid=0) {
286         global $DB;
288         if ($recordid) {
289             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
290         } else {
291             $conditions = array('fieldid'=>$this->field->id);
292         }
294         if ($rs = $DB->get_recordset('data_content', $conditions)) {
295             $fs = get_file_storage();
296             foreach ($rs as $content) {
297                 $fs->delete_area_files($this->context->id, 'data_content', $content->id);
298             }
299             $rs->close();
300         }
302         return $DB->delete_records('data_content', $conditions);
303     }
305 // Check if a field from an add form is empty
306     function notemptyfield($value, $name) {
307         return !empty($value);
308     }
310 // Just in case a field needs to print something before the whole form
311     function print_before_form() {
312     }
314 // Just in case a field needs to print something after the whole form
315     function print_after_form() {
316     }
319 // Returns the sortable field for the content. By default, it's just content
320 // but for some plugins, it could be content 1 - content4
321     function get_sort_field() {
322         return 'content';
323     }
325 // Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
326     function get_sort_sql($fieldname) {
327         return $fieldname;
328     }
330 // Returns the name/type of the field
331     function name() {
332         return get_string('name'.$this->type, 'data');
333     }
335 // Prints the respective type icon
336     function image() {
337         global $CFG;
339         $str = '<a href="field.php?d='.$this->data->id.'&amp;fid='.$this->field->id.'&amp;mode=display&amp;sesskey='.sesskey().'">';
340         $str .= '<img src="'.$CFG->modpixpath.'/data/field/'.$this->type.'/icon.gif" ';
341         $str .= 'height="'.$this->iconheight.'" width="'.$this->iconwidth.'" alt="'.$this->type.'" title="'.$this->type.'" /></a>';
342         return $str;
343     }
345 //  Per default, it is assumed that fields support text exporting. Override this (return false) on fields not supporting text exporting.
346     function text_export_supported() {
347         return true;
348     }
350 //  Per default, return the record's text value only from the "content" field. Override this in fields class if necesarry.
351     function export_text_value($record) {
352         if ($this->text_export_supported()) {
353             return $record->content;
354         }
355     }
357     function file_ok($relativepath) {
358         return false;
359     }
363 /*****************************************************************************
364 /* Given a template and a dataid, generate a default case template               *
365  * input @param template - addtemplate, singletemplate, listtempalte, rsstemplate*
366  *       @param dataid                                                       *
367  * output null                                                               *
368  *****************************************************************************/
369 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
370     global $DB;
372     if (!$data && !$template) {
373         return false;
374     }
375     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
376         return '';
377     }
379     // get all the fields for that database
380     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
382         $str = '<div class="defaulttemplate">';
383         $str .= '<table cellpadding="5">';
385         foreach ($fields as $field) {
387             $str .= '<tr><td valign="top" align="right">';
388             // Yu: commenting this out, the id was wrong and will fix later
389             //if ($template == 'addtemplate') {
390                 //$str .= '<label';
391                 //if (!in_array($field->type, array('picture', 'checkbox', 'date', 'latlong', 'radiobutton'))) {
392                 //    $str .= ' for="[['.$field->name.'#id]]"';
393                 //}
394                 //$str .= '>'.$field->name.'</label>';
396             //} else {
397                 $str .= $field->name.': ';
398             //}
399             $str .= '</td>';
401             $str .='<td>';
402             if ($form) {   // Print forms instead of data
403                 $fieldobj = data_get_field($field, $data);
404                 $str .= $fieldobj->display_add_field($recordid);
406             } else {           // Just print the tag
407                 $str .= '[['.$field->name.']]';
408             }
409             $str .= '</td></tr>';
411         }
412         if ($template == 'listtemplate') {
413             $str .= '<tr><td align="center" colspan="2">##edit##  ##more##  ##delete##  ##approve##  ##export##</td></tr>';
414         } else if ($template == 'singletemplate') {
415             $str .= '<tr><td align="center" colspan="2">##edit##  ##delete##  ##approve##  ##export##</td></tr>';
416         } else if ($template == 'asearchtemplate') {
417             $str .= '<tr><td valign="top" align="right">'.get_string('authorfirstname', 'data').': </td><td>##firstname##</td></tr>';
418             $str .= '<tr><td valign="top" align="right">'.get_string('authorlastname', 'data').': </td><td>##lastname##</td></tr>';
419         }
421         $str .= '</table>';
422         $str .= '</div>';
424         if ($template == 'listtemplate'){
425             $str .= '<hr />';
426         }
428         if ($update) {
429             $newdata = new object();
430             $newdata->id = $data->id;
431             $newdata->{$template} = $str;
432             if (!$DB->update_record('data', $newdata)) {
433                 notify('Error updating template');
434             } else {
435                 $data->{$template} = $str;
436             }
437         }
439         return $str;
440     }
444 /***********************************************************************
445  * Search for a field name and replaces it with another one in all the *
446  * form templates. Set $newfieldname as '' if you want to delete the   *
447  * field from the form.                                                *
448  ***********************************************************************/
449 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
450     global $DB;
452     if (!empty($newfieldname)) {
453         $prestring = '[[';
454         $poststring = ']]';
455         $idpart = '#id';
457     } else {
458         $prestring = '';
459         $poststring = '';
460         $idpart = '';
461     }
463     $newdata = new object();
464     $newdata->id = $data->id;
465     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
466             $prestring.$newfieldname.$poststring, $data->singletemplate);
468     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
469             $prestring.$newfieldname.$poststring, $data->listtemplate);
471     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
472             $prestring.$newfieldname.$poststring, $data->addtemplate);
474     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
475             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
477     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
478             $prestring.$newfieldname.$poststring, $data->rsstemplate);
480     return $DB->update_record('data', $newdata);
484 /********************************************************
485  * Appends a new field at the end of the form template. *
486  ********************************************************/
487 function data_append_new_field_to_templates($data, $newfieldname) {
488     global $DB;
490     $newdata = new object();
491     $newdata->id = $data->id;
492     $change = false;
494     if (!empty($data->singletemplate)) {
495         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
496         $change = true;
497     }
498     if (!empty($data->addtemplate)) {
499         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
500         $change = true;
501     }
502     if (!empty($data->rsstemplate)) {
503         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
504         $change = true;
505     }
506     if ($change) {
507         $DB->update_record('data', $newdata);
508     }
512 /************************************************************************
513  * given a field name *
514  * this function creates an instance of the particular subfield class   *
515  ************************************************************************/
516 function data_get_field_from_name($name, $data){
517     global $DB;
519     $field = $DB->get_record('data_fields', array('name'=>$name));
521     if ($field) {
522         return data_get_field($field, $data);
523     } else {
524         return false;
525     }
528 /************************************************************************
529  * given a field id *
530  * this function creates an instance of the particular subfield class   *
531  ************************************************************************/
532 function data_get_field_from_id($fieldid, $data){
533     global $DB;
535     $field = $DB->get_record('data_fields', array('id'=>$fieldid));
537     if ($field) {
538         return data_get_field($field, $data);
539     } else {
540         return false;
541     }
544 /************************************************************************
545  * given a field id *
546  * this function creates an instance of the particular subfield class   *
547  ************************************************************************/
548 function data_get_field_new($type, $data) {
549     global $CFG;
551     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
552     $newfield = 'data_field_'.$type;
553     $newfield = new $newfield(0, $data);
554     return $newfield;
557 /************************************************************************
558  * returns a subclass field object given a record of the field, used to *
559  * invoke plugin methods                                                *
560  * input: $param $field - record from db                                *
561  ************************************************************************/
562 function data_get_field($field, $data, $cm=null) {
563     global $CFG;
565     if ($field) {
566         require_once('field/'.$field->type.'/field.class.php');
567         $newfield = 'data_field_'.$field->type;
568         $newfield = new $newfield($field, $data, $cm);
569         return $newfield;
570     }
574 /**
575  * Given record object (or id), returns true if the record belongs to the current user
576  * @param mixed $rid - record object or id
577  * @return bool
578  */
579 function data_isowner($record) {
580     global $USER, $DB;
582     if (!isloggedin()) {
583         return false;
584     }
586     if (!is_object($record)) {
587         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
588             return false;
589         }
590     }
592     return ($record->userid == $USER->id);
595 /***********************************************************************
596  * has a user reached the max number of entries?                       *
597  * input object $data                                                  *
598  * output bool                                                         *
599  ***********************************************************************/
600 function data_atmaxentries($data){
601     if (!$data->maxentries){
602         return false;
604     } else {
605         return (data_numentries($data) >= $data->maxentries);
606     }
609 /**********************************************************************
610  * returns the number of entries already made by this user            *
611  * input @param object $data                                          *
612  * uses global $CFG, $USER                                            *
613  * output int                                                         *
614  **********************************************************************/
615 function data_numentries($data){
616     global $USER, $DB;
617     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
618     return $DB->count_records_sql($sql, array($data->id, $USER->id));
621 /****************************************************************
622  * function that takes in a dataid and adds a record            *
623  * this is used everytime an add template is submitted          *
624  * input @param int $dataid, $groupid                           *
625  * output bool                                                  *
626  ****************************************************************/
627 function data_add_record($data, $groupid=0){
628     global $USER, $DB;
630     $cm = get_coursemodule_from_instance('data', $data->id);
631     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
633     $record = new object();
634     $record->userid = $USER->id;
635     $record->dataid = $data->id;
636     $record->groupid = $groupid;
637     $record->timecreated = $record->timemodified = time();
638     if (has_capability('mod/data:approve', $context)) {
639         $record->approved = 1;
640     } else {
641         $record->approved = 0;
642     }
643     return $DB->insert_record('data_records', $record);
646 /*******************************************************************
647  * check the multple existence any tag in a template               *
648  * input @param string                                             *
649  * output true-valid, false-invalid                                *
650  * check to see if there are 2 or more of the same tag being used. *
651  * input @param int $dataid,                                       *
652  *       @param string $template                                   *
653  * output bool                                                     *
654  *******************************************************************/
655 function data_tags_check($dataid, $template) {
656     global $DB;
658     // first get all the possible tags
659     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
660     // then we generate strings to replace
661     $tagsok = true; // let's be optimistic
662     foreach ($fields as $field){
663         $pattern="/\[\[".$field->name."\]\]/i";
664         if (preg_match_all($pattern, $template, $dummy)>1){
665             $tagsok = false;
666             notify ('[['.$field->name.']] - '.get_string('multipletags','data'));
667         }
668     }
669     // else return true
670     return $tagsok;
673 /************************************************************************
674  * Adds an instance of a data                                           *
675  ************************************************************************/
676 function data_add_instance($data) {
677     global $DB;
679     if (empty($data->assessed)) {
680         $data->assessed = 0;
681     }
683     $data->timemodified = time();
685     if (! $data->id = $DB->insert_record('data', $data)) {
686         return false;
687     }
689     data_grade_item_update($data);
691     return $data->id;
694 /************************************************************************
695  * updates an instance of a data                                        *
696  ************************************************************************/
697 function data_update_instance($data) {
698     global $DB;
700     $data->timemodified = time();
701     $data->id           = $data->instance;
703     if (empty($data->assessed)) {
704         $data->assessed = 0;
705     }
707     if (empty($data->notification)) {
708         $data->notification = 0;
709     }
711     if (! $DB->update_record('data', $data)) {
712         return false;
713     }
715     data_grade_item_update($data);
717     return true;
721 /************************************************************************
722  * deletes an instance of a data                                        *
723  ************************************************************************/
724 function data_delete_instance($id) {    // takes the dataid
725     global $DB;
727     if (!$data = $DB->get_record('data', array('id'=>$id))) {
728         return false;
729     }
731     $cm = get_coursemodule_from_instance('data', $data->id);
732     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
734 /// Delete all the associated information
736     // files
737     $fs = get_file_storage();
738     $fs->delete_area_files($context->id, 'data_content');
740     // get all the records in this data
741     $sql = "SELECT r.id
742               FROM {data_records} r
743              WHERE r.dataid = ?";
745     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
747     // delete all the records and fields
748     $DB->delete_records('data_records', array('dataid'=>$id));
749     $DB->delete_records('data_fields', array('dataid'=>$id));
751     // Delete the instance itself
752     $result = $DB->delete_records('data', array('id'=>$id));
754     // cleanup gradebook
755     data_grade_item_delete($data);
757     return $result;
760 /************************************************************************
761  * returns a summary of data activity of this user                      *
762  ************************************************************************/
763 function data_user_outline($course, $user, $mod, $data) {
764     global $DB;
766     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
767         $result = new object();
768         $result->info = get_string('numrecords', 'data', $countrecords);
769         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
770                                               WHERE dataid = ? AND userid = ?
771                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
772         $result->time = $lastrecord->timemodified;
773         return $result;
774     }
775     return NULL;
778 /************************************************************************
779  * Prints all the records uploaded by this user                         *
780  ************************************************************************/
781 function data_user_complete($course, $user, $mod, $data) {
782     global $DB;
784     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
785         data_print_template('singletemplate', $records, $data);
786     }
789 /**
790  * Return grade for given user or all users.
791  *
792  * @param int $dataid id of data
793  * @param int $userid optional user id, 0 means all users
794  * @return array array of grades, false if none
795  */
796 function data_get_user_grades($data, $userid=0) {
797     global $DB;
799     $user = $userid ? "AND u.id = :userid" : "";
800     $params = array('userid'=>$userid, 'dataid'=>$data->id);
802     $sql = "SELECT u.id, u.id AS userid, avg(drt.rating) AS rawgrade
803               FROM {user} u, {data_records} dr,
804                    {data_ratings} drt
805              WHERE u.id = dr.userid AND dr.id = drt.recordid
806                    AND drt.userid != u.id AND dr.dataid = :dataid
807                    $user
808           GROUP BY u.id";
810     return $DB->get_records_sql($sql, $params);
813 /**
814  * Update activity grades
815  *
816  * @param object $data
817  * @param int $userid specific user only, 0 means all
818  */
819 function data_update_grades($data, $userid=0, $nullifnone=true) {
820     global $CFG, $DB;
821     require_once($CFG->libdir.'/gradelib.php');
823     if (!$data->assessed) {
824         data_grade_item_update($data);
826     } else if ($grades = data_get_user_grades($data, $userid)) {
827         data_grade_item_update($data, $grades);
829     } else if ($userid and $nullifnone) {
830         $grade = new object();
831         $grade->userid   = $userid;
832         $grade->rawgrade = NULL;
833         data_grade_item_update($data, $grade);
835     } else {
836         data_grade_item_update($data);
837     }
840 /**
841  * Update all grades in gradebook.
842  */
843 function data_upgrade_grades() {
844     global $DB;
846     $sql = "SELECT COUNT('x')
847               FROM {data} d, {course_modules} cm, {modules} m
848              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
849     $count = $DB->count_records_sql($sql);
851     $sql = "SELECT d.*, cm.idnumber AS cmidnumber, d.course AS courseid
852               FROM {data} d, {course_modules} cm, {modules} m
853              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
854     if ($rs = $DB->get_recordset_sql($sql)) {
855         // too much debug output
856         $pbar = new progress_bar('dataupgradegrades', 500, true);
857         $i=0;
858         foreach ($rs as $data) {
859             $i++;
860             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
861             data_update_grades($data, 0, false);
862             $pbar->update($i, $count, "Updating Database grades ($i/$count).");
863         }
864         $rs->close();
865     }
868 /**
869  * Update/create grade item for given data
870  *
871  * @param object $data object with extra cmidnumber
872  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
873  * @return object grade_item
874  */
875 function data_grade_item_update($data, $grades=NULL) {
876     global $CFG;
877     require_once($CFG->libdir.'/gradelib.php');
879     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
881     if (!$data->assessed or $data->scale == 0) {
882         $params['gradetype'] = GRADE_TYPE_NONE;
884     } else if ($data->scale > 0) {
885         $params['gradetype'] = GRADE_TYPE_VALUE;
886         $params['grademax']  = $data->scale;
887         $params['grademin']  = 0;
889     } else if ($data->scale < 0) {
890         $params['gradetype'] = GRADE_TYPE_SCALE;
891         $params['scaleid']   = -$data->scale;
892     }
894     if ($grades  === 'reset') {
895         $params['reset'] = true;
896         $grades = NULL;
897     }
899     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
902 /**
903  * Delete grade item for given data
904  *
905  * @param object $data object
906  * @return object grade_item
907  */
908 function data_grade_item_delete($data) {
909     global $CFG;
910     require_once($CFG->libdir.'/gradelib.php');
912     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
915 /************************************************************************
916  * returns a list of participants of this database                      *
917  ************************************************************************/
918 function data_get_participants($dataid) {
919 // Returns the users with data in one data
920 // (users with records in data_records, data_comments and data_ratings)
921     global $DB;
923     $records = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
924                                        FROM {user} u, {data_records} r
925                                       WHERE r.dataid = ? AND u.id = r.userid", array($dataid));
927     $comments = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
928                                         FROM {user} u, {data_records} r, {data_comments} c
929                                        WHERE r.dataid = ? AND u.id = r.userid AND r.id = c.recordid", array($dataid));
931     $ratings = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
932                                        FROM {user} u, {data_records} r, {data_ratings} a
933                                       WHERE r.dataid = ? AND u.id = r.userid AND r.id = a.recordid", array($dataid));
935     $participants = array();
937     if ($records) {
938         foreach ($records as $record) {
939             $participants[$record->id] = $record;
940         }
941     }
942     if ($comments) {
943         foreach ($comments as $comment) {
944             $participants[$comment->id] = $comment;
945         }
946     }
947     if ($ratings) {
948         foreach ($ratings as $rating) {
949             $participants[$rating->id] = $rating;
950         }
951     }
953     return $participants;
956 // junk functions
957 /************************************************************************
958  * takes a list of records, the current data, a search string,          *
959  * and mode to display prints the translated template                   *
960  * input @param array $records                                          *
961  *       @param object $data                                            *
962  *       @param string $search                                          *
963  *       @param string $template                                        *
964  * output null                                                          *
965  ************************************************************************/
966 function data_print_template($template, $records, $data, $search='', $page=0, $return=false) {
967     global $CFG, $DB;
968     $cm = get_coursemodule_from_instance('data', $data->id);
969     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
971     static $fields = NULL;
972     static $isteacher;
973     static $dataid = NULL;
975     if (empty($dataid)) {
976         $dataid = $data->id;
977     } else if ($dataid != $data->id) {
978         $fields = NULL;
979     }
981     if (empty($fields)) {
982         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
983         foreach ($fieldrecords as $fieldrecord) {
984             $fields[]= data_get_field($fieldrecord, $data);
985         }
986         $isteacher = has_capability('mod/data:managetemplates', $context);
987     }
989     if (empty($records)) {
990         return;
991     }
993     foreach ($records as $record) {   // Might be just one for the single template
995     // Replacing tags
996         $patterns = array();
997         $replacement = array();
999     // Then we generate strings to replace for normal tags
1000         foreach ($fields as $field) {
1001             $patterns[]='[['.$field->field->name.']]';
1002             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1003         }
1005     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1006         $patterns[]='##edit##';
1007         $patterns[]='##delete##';
1008         if (has_capability('mod/data:manageentries', $context) or data_isowner($record->id)) {
1009             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1010                              .$data->id.'&amp;rid='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$CFG->pixpath.'/t/edit.gif" class="iconsmall" alt="'.get_string('edit').'" title="'.get_string('edit').'" /></a>';
1011             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1012                              .$data->id.'&amp;delete='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$CFG->pixpath.'/t/delete.gif" class="iconsmall" alt="'.get_string('delete').'" title="'.get_string('delete').'" /></a>';
1013         } else {
1014             $replacement[] = '';
1015             $replacement[] = '';
1016         }
1018         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1019         if ($search) {
1020             $moreurl .= '&amp;filter=1';
1021         }
1022         $patterns[]='##more##';
1023         $replacement[] = '<a href="' . $moreurl . '"><img src="' . $CFG->pixpath . '/i/search.gif" class="iconsmall" alt="' . get_string('more', 'data') . '" title="' . get_string('more', 'data') . '" /></a>';
1025         $patterns[]='##moreurl##';
1026         $replacement[] = $moreurl;
1028         $patterns[]='##user##';
1029         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1030                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1032         $patterns[]='##export##';
1034         if (($template == 'singletemplate' || $template == 'listtemplate')
1035             && ((has_capability('mod/data:exportentry', $context)
1036                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1037             $button = new portfolio_add_button();
1038             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id));
1039             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1040             $button->set_formats($formats);
1041             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1042         } else {
1043             $replacement[] = '';
1044         }
1046         $patterns[] = '##timeadded##';
1047         $replacement[] = userdate($record->timecreated);
1049         $patterns[] = '##timemodified##';
1050         $replacement [] = userdate($record->timemodified);
1052         $patterns[]='##approve##';
1053         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)){
1054             $replacement[] = '<span class="approve"><a href="'.$CFG->wwwroot.'/mod/data/view.php?d='.$data->id.'&amp;approve='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$CFG->pixpath.'/i/approve.gif" class="icon" alt="'.get_string('approve').'" /></a></span>';
1055         } else {
1056             $replacement[] = '';
1057         }
1059         $patterns[]='##comments##';
1060         if (($template == 'listtemplate') && ($data->comments)) {
1061             $comments = $DB->count_records('data_comments', array('recordid'=>$record->id));
1062             $replacement[] = '<a href="view.php?rid='.$record->id.'#comments">'.get_string('commentsn','data', $comments).'</a>';
1063         } else {
1064             $replacement[] = '';
1065         }
1067         // actual replacement of the tags
1068         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1070         // no more html formatting and filtering - see MDL-6635
1071         if ($return) {
1072             return $newtext;
1073         } else {
1074             echo $newtext;
1076             // hack alert - return is always false in singletemplate anyway ;-)
1077             /**********************************
1078              *    Printing Ratings Form       *
1079              *********************************/
1080             if ($template == 'singletemplate') {    //prints ratings options
1081                 data_print_ratings($data, $record);
1082             }
1084             /**********************************
1085              *    Printing Ratings Form       *
1086              *********************************/
1087             if (($template == 'singletemplate') && ($data->comments)) {    //prints ratings options
1089                 data_print_comments($data, $record, $page);
1090             }
1091         }
1092     }
1096 /************************************************************************
1097  * function that takes in the current data, number of items per page,   *
1098  * a search string and prints a preference box in view.php              *
1099  *                                                                      *
1100  * This preference box prints a searchable advanced search template if  *
1101  *     a) A template is defined                                         *
1102  *  b) The advanced search checkbox is checked.                         *
1103  *                                                                      *
1104  * input @param object $data                                            *
1105  *       @param int $perpage                                            *
1106  *       @param string $search                                          *
1107  * output null                                                          *
1108  ************************************************************************/
1109 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1110     global $CFG, $DB;
1112     $cm = get_coursemodule_from_instance('data', $data->id);
1113     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1114     echo '<br /><div class="datapreferences">';
1115     echo '<form id="options" action="view.php" method="get">';
1116     echo '<div>';
1117     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1118     if ($mode =='asearch') {
1119         $advanced = 1;
1120         echo '<input type="hidden" name="mode" value="list" />';
1121     }
1122     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1123     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1124                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1125     choose_from_menu($pagesizes, 'perpage', $perpage, '', '', '0', false, false, 0, 'pref_perpage');
1126      echo '<div id="reg_search" style="display: ';
1127     if ($advanced) {
1128         echo 'none';
1129     }
1130     else {
1131         echo 'inline';
1132     }
1133     echo ';" >&nbsp;&nbsp;&nbsp;<label for="pref_search">'.get_string('search').'</label> <input type="text" size="16" name="search" id= "pref_search" value="'.s($search).'" /></div>';
1134     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1135     // foreach field, print the option
1136     echo '<select name="sort" id="pref_sortby">';
1137     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1138         echo '<optgroup label="'.get_string('fields', 'data').'">';
1139         foreach ($fields as $field) {
1140             if ($field->id == $sort) {
1141                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1142             } else {
1143                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1144             }
1145         }
1146         echo '</optgroup>';
1147     }
1148     $options = array();
1149     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1150     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1151     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1152     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1153     if ($data->approval and has_capability('mod/data:approve', $context)) {
1154         $options[DATA_APPROVED] = get_string('approved', 'data');
1155     }
1156     echo '<optgroup label="'.get_string('other', 'data').'">';
1157     foreach ($options as $key => $name) {
1158         if ($key == $sort) {
1159             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1160         } else {
1161             echo '<option value="'.$key.'">'.$name.'</option>';
1162         }
1163     }
1164     echo '</optgroup>';
1165     echo '</select>';
1166     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1167     echo '<select id="pref_order" name="order">';
1168     if ($order == 'ASC') {
1169         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1170     } else {
1171         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1172     }
1173     if ($order == 'DESC') {
1174         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1175     } else {
1176         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1177     }
1178     echo '</select>';
1180     if ($advanced) {
1181         $checked = ' checked="checked" ';
1182     }
1183     else {
1184         $checked = '';
1185     }
1186     print '
1188         <script type="text/javascript">
1189         //<![CDATA[
1190         <!-- Start
1191         // javascript for hiding/displaying advanced search form
1193         function showHideAdvSearch(checked) {
1194             var divs = document.getElementsByTagName(\'div\');
1195             for(i=0;i<divs.length;i++) {
1196                 if(divs[i].id.match(\'data_adv_form\')) {
1197                     if(checked) {
1198                         divs[i].style.display = \'inline\';
1199                     }
1200                     else {
1201                         divs[i].style.display = \'none\';
1202                     }
1203                 }
1204                 else if (divs[i].id.match(\'reg_search\')) {
1205                     if (!checked) {
1206                         divs[i].style.display = \'inline\';
1207                     }
1208                     else {
1209                         divs[i].style.display = \'none\';
1210                     }
1211                 }
1212             }
1213         }
1214         //  End -->
1215         //]]>
1216         </script>';
1217     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1218     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1219     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1220     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1222     echo '<br />';
1223     echo '<div class="dataadvancedsearch" id="data_adv_form" style="display: ';
1225     if ($advanced) {
1226         echo 'inline';
1227     }
1228     else {
1229         echo 'none';
1230     }
1231     echo ';margin-left:auto;margin-right:auto;" >';
1232     echo '<table class="boxaligncenter">';
1234     // print ASC or DESC
1235     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1236     $i = 0;
1238     // Determine if we are printing all fields for advanced search, or the template for advanced search
1239     // If a template is not defined, use the deafault template and display all fields.
1240     if(empty($data->asearchtemplate)) {
1241         data_generate_default_template($data, 'asearchtemplate');
1242     }
1244     static $fields = NULL;
1245     static $isteacher;
1246     static $dataid = NULL;
1248     if (empty($dataid)) {
1249         $dataid = $data->id;
1250     } else if ($dataid != $data->id) {
1251         $fields = NULL;
1252     }
1254     if (empty($fields)) {
1255         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1256         foreach ($fieldrecords as $fieldrecord) {
1257             $fields[]= data_get_field($fieldrecord, $data);
1258         }
1260         $isteacher = has_capability('mod/data:managetemplates', $context);
1261     }
1263     // Replacing tags
1264     $patterns = array();
1265     $replacement = array();
1267     // Then we generate strings to replace for normal tags
1268     foreach ($fields as $field) {
1269         $fieldname = $field->field->name;
1270         $fieldname = preg_quote($fieldname, '/');
1271         $patterns[] = "/\[\[$fieldname\]\]/i";
1272         $searchfield = data_get_field_from_id($field->field->id, $data);
1273         if (!empty($search_array[$field->field->id]->data)) {
1274             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1275         } else {
1276             $replacement[] = $searchfield->display_search_field();
1277         }
1278     }
1279     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1280     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1281     $patterns[]    = '/##firstname##/';
1282     $replacement[] = '<input type="text" size="16" name="u_fn" value="'.$fn.'" />';
1283     $patterns[]    = '/##lastname##/';
1284     $replacement[] = '<input type="text" size="16" name="u_ln" value="'.$ln.'" />';
1286     // actual replacement of the tags
1287     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1289     $options = new object();
1290     $options->para=false;
1291     $options->noclean=true;
1292     echo '<tr><td>';
1293     echo format_text($newtext, FORMAT_HTML, $options);
1294     echo '</td></tr>';
1296     echo '<tr><td colspan="4" style="text-align: center;"><br/><input type="submit" value="'.get_string('savesettings','data').'" /><input type="submit" name="resetadv" value="'.get_string('resetsettings','data').'" /></td></tr>';
1297     echo '</table>';
1298     echo '</div>';
1299     echo '</div>';
1300     echo '</form>';
1301     echo '</div>';
1304 function data_print_ratings($data, $record) {
1305     global $USER, $DB;
1307     $cm = get_coursemodule_from_instance('data', $data->id);
1308     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1310     if ($data->assessed and !empty($USER->id) and (has_capability('mod/data:rate', $context) or has_capability('mod/data:viewrating', $context) or data_isowner($record->id))) {
1311         if ($ratingsscale = make_grades_menu($data->scale)) {
1312             $ratingsmenuused = false;
1314             echo '<div class="ratings" style="text-align:center">';
1315             echo '<form id="form" method="post" action="rate.php">';
1316             echo '<input type="hidden" name="dataid" value="'.$data->id.'" />';
1318             if (has_capability('mod/data:rate', $context) and !data_isowner($record->id)) {
1319                 data_print_ratings_mean($record->id, $ratingsscale, has_capability('mod/data:viewrating', $context));
1320                 echo '&nbsp;';
1321                 data_print_rating_menu($record->id, $USER->id, $ratingsscale);
1322                 $ratingsmenuused = true;
1324             } else {
1325                 data_print_ratings_mean($record->id, $ratingsscale, true);
1326             }
1328             if ($data->scale < 0) {
1329                 if ($scale = $DB->get_record('scale', array('id'=>abs($data->scale)))) {
1330                     print_scale_menu_helpbutton($data->course, $scale );
1331                 }
1332             }
1334             if ($ratingsmenuused) {
1335                 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1336                 echo '<input type="submit" value="'.get_string('sendinratings', 'data').'" />';
1337             }
1338             echo '</form>';
1339             echo '</div>';
1340         }
1341     }
1344 function data_print_ratings_mean($recordid, $scale, $link=true) {
1345 // Print the multiple ratings on a post given to the current user by others.
1346 // Scale is an array of ratings
1347     static $strrate;
1349     $mean = data_get_ratings_mean($recordid, $scale);
1351     if ($mean !== "") {
1353         if (empty($strratings)) {
1354             $strratings = get_string("ratings", "data");
1355         }
1357         echo "$strratings: ";
1358         if ($link) {
1359             link_to_popup_window ("/mod/data/report.php?id=$recordid", "ratings", $mean, 400, 600);
1360         } else {
1361             echo "$mean ";
1362         }
1363     }
1367 function data_get_ratings_mean($recordid, $scale, $ratings=NULL) {
1368 // Return the mean rating of a post given to the current user by others.
1369 // Scale is an array of possible ratings in the scale
1370 // Ratings is an optional simple array of actual ratings (just integers)
1371     global $DB;
1373     if (!$ratings) {
1374         $ratings = array();
1375         if ($rates = $DB->get_records("data_ratings", array("recordid"=>$recordid))) {
1376             foreach ($rates as $rate) {
1377                 $ratings[] = $rate->rating;
1378             }
1379         }
1380     }
1382     $count = count($ratings);
1384     if ($count == 0) {
1385         return "";
1387     } else if ($count == 1) {
1388         return $scale[$ratings[0]];
1390     } else {
1391         $total = 0;
1392         foreach ($ratings as $rating) {
1393             $total += $rating;
1394         }
1395         $mean = round( ((float)$total/(float)$count) + 0.001);  // Little fudge factor so that 0.5 goes UP
1397         if (isset($scale[$mean])) {
1398             return $scale[$mean]." ($count)";
1399         } else {
1400             return "$mean ($count)";    // Should never happen, hopefully
1401         }
1402     }
1406 function data_print_rating_menu($recordid, $userid, $scale) {
1407 // Print the menu of ratings as part of a larger form.
1408 // If the post has already been - set that value.
1409 // Scale is an array of ratings
1410     global $DB;
1412     static $strrate;
1414     if (!$rating = $DB->get_record("data_ratings", array("userid"=>$userid, "recordid"=>$recordid))) {
1415         $rating->rating = -999;
1416     }
1418     if (empty($strrate)) {
1419         $strrate = get_string("rate", "data");
1420     }
1422     choose_from_menu($scale, $recordid, $rating->rating, "$strrate...", '', -999);
1425 /**
1426  * Returns a list of ratings for a particular post - sorted.
1427  */
1428 function data_get_ratings($recordid, $sort="u.firstname ASC") {
1429     global  $DB;
1431     return $DB->get_records_sql("SELECT u.*, r.rating
1432                                    FROM {data_ratings} r, {user} u
1433                                   WHERE r.recordid = ? AND r.userid = u.id
1434                                ORDER BY $sort", array($recordid));
1437 // prints all comments + a text box for adding additional comment
1438 function data_print_comments($data, $record, $page=0, $mform=false) {
1439     global $CFG, $DB;
1441     $cm = get_coursemodule_from_instance('data', $data->id);
1442     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1443     $cancomment = has_capability('mod/data:comment', $context);
1444     echo '<a name="comments"></a>';
1446     if ($comments = $DB->get_records('data_comments', array('recordid'=>$record->id))) {
1447         foreach ($comments as $comment) {
1448             data_print_comment($data, $comment, $page);
1449         }
1450         echo '<br />';
1451     }
1453     if (!isloggedin() or isguest() or !$cancomment) {
1454         return;
1455     }
1457     $editor = optional_param('addcomment', 0, PARAM_BOOL);
1459     if (!$mform and !$editor) {
1460         echo '<div class="newcomment" style="text-align:center">';
1461         echo '<a href="view.php?d='.$data->id.'&amp;rid='.$record->id.'&amp;mode=single&amp;addcomment=1">'.get_string('addcomment', 'data').'</a>';
1462         echo '</div>';
1463     } else {
1464         if (!$mform) {
1465             require_once('comment_form.php');
1466             $mform = new mod_data_comment_form('comment.php');
1467             $mform->set_data(array('mode'=>'add', 'page'=>$page, 'rid'=>$record->id));
1468         }
1469         echo '<div class="newcomment" style="text-align:center">';
1470         $mform->display();
1471         echo '</div>';
1472     }
1475 // prints a single comment entry
1476 function data_print_comment($data, $comment, $page=0) {
1477     global $USER, $CFG, $DB;
1479     $cm = get_coursemodule_from_instance('data', $data->id);
1480     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1482     $stredit = get_string('edit');
1483     $strdelete = get_string('delete');
1485     $user = $DB->get_record('user', array('id'=>$comment->userid));
1487     echo '<table cellspacing="0" align="center" width="50%" class="datacomment forumpost">';
1489     echo '<tr class="header"><td class="picture left">';
1490     print_user_picture($user, $data->course, $user->picture);
1491     echo '</td>';
1493     echo '<td class="topic starter" align="left"><div class="author">';
1494     $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $context));
1495     $by = new object();
1496     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.
1497                 $user->id.'&amp;course='.$data->course.'">'.$fullname.'</a>';
1498     $by->date = userdate($comment->modified);
1499     print_string('bynameondate', 'data', $by);
1500     echo '</div></td></tr>';
1502     echo '<tr><td class="left side">';
1503     if ($groups = groups_get_all_groups($data->course, $comment->userid, $cm->groupingid)) {
1504         print_group_picture($groups, $data->course, false, false, true);
1505     } else {
1506         echo '&nbsp;';
1507     }
1509 // Actual content
1511     echo '</td><td class="content" align="left">'."\n";
1513     // Print whole message
1514     echo format_text($comment->content, $comment->format);
1516 // Commands
1518     echo '<div class="commands">';
1519     if (data_isowner($comment->recordid) or has_capability('mod/data:managecomments', $context)) {
1520             echo '<a href="'.$CFG->wwwroot.'/mod/data/comment.php?rid='.$comment->recordid.'&amp;mode=edit&amp;commentid='.$comment->id.'&amp;page='.$page.'">'.$stredit.'</a>';
1521             echo '| <a href="'.$CFG->wwwroot.'/mod/data/comment.php?rid='.$comment->recordid.'&amp;mode=delete&amp;commentid='.$comment->id.'&amp;page='.$page.'">'.$strdelete.'</a>';
1522     }
1524     echo '</div>';
1526     echo '</td></tr></table>'."\n\n";
1530 // For Participantion Reports
1531 function data_get_view_actions() {
1532     return array('view');
1535 function data_get_post_actions() {
1536     return array('add','update','record delete');
1539 function data_fieldname_exists($name, $dataid, $fieldid=0) {
1540     global $CFG, $DB;
1542     $LIKE = $DB->sql_ilike();
1543     if ($fieldid) {
1544         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1545                                         WHERE df.name $LIKE ? AND df.dataid = ?
1546                                               AND ((df.id < ?) OR (df.id > ?))", array($name, $dataid, $fieldid, $fieldid));
1547     } else {
1548         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1549                                         WHERE df.name $LIKE ? AND df.dataid = ?", array($name, $dataid));
1550     }
1553 function data_convert_arrays_to_strings(&$fieldinput) {
1554     foreach ($fieldinput as $key => $val) {
1555         if (is_array($val)) {
1556             $str = '';
1557             foreach ($val as $inner) {
1558                 $str .= $inner . ',';
1559             }
1560             $str = substr($str, 0, -1);
1562             $fieldinput->$key = $str;
1563         }
1564     }
1568 /**
1569  * Converts a database (module instance) to use the Roles System
1570  * @param $data         - a data object with the same attributes as a record
1571  *                        from the data database table
1572  * @param $datamodid    - the id of the data module, from the modules table
1573  * @param $teacherroles - array of roles that have moodle/legacy:teacher
1574  * @param $studentroles - array of roles that have moodle/legacy:student
1575  * @param $guestroles   - array of roles that have moodle/legacy:guest
1576  * @param $cmid         - the course_module id for this data instance
1577  * @return boolean      - data module was converted or not
1578  */
1579 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1580     global $CFG, $DB;
1582     if (!isset($data->participants) && !isset($data->assesspublic)
1583             && !isset($data->groupmode)) {
1584         // We assume that this database has already been converted to use the
1585         // Roles System. above fields get dropped the data module has been
1586         // upgraded to use Roles.
1587         return false;
1588     }
1590     if (empty($cmid)) {
1591         // We were not given the course_module id. Try to find it.
1592         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1593             notify('Could not get the course module for the data');
1594             return false;
1595         } else {
1596             $cmid = $cm->id;
1597         }
1598     }
1599     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1602     // $data->participants:
1603     // 1 - Only teachers can add entries
1604     // 3 - Teachers and students can add entries
1605     switch ($data->participants) {
1606         case 1:
1607             foreach ($studentroles as $studentrole) {
1608                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1609             }
1610             foreach ($teacherroles as $teacherrole) {
1611                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1612             }
1613             break;
1614         case 3:
1615             foreach ($studentroles as $studentrole) {
1616                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1617             }
1618             foreach ($teacherroles as $teacherrole) {
1619                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1620             }
1621             break;
1622     }
1624     // $data->assessed:
1625     // 2 - Only teachers can rate posts
1626     // 1 - Everyone can rate posts
1627     // 0 - No one can rate posts
1628     switch ($data->assessed) {
1629         case 0:
1630             foreach ($studentroles as $studentrole) {
1631                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1632             }
1633             foreach ($teacherroles as $teacherrole) {
1634                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1635             }
1636             break;
1637         case 1:
1638             foreach ($studentroles as $studentrole) {
1639                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1640             }
1641             foreach ($teacherroles as $teacherrole) {
1642                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1643             }
1644             break;
1645         case 2:
1646             foreach ($studentroles as $studentrole) {
1647                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1648             }
1649             foreach ($teacherroles as $teacherrole) {
1650                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1651             }
1652             break;
1653     }
1655     // $data->assesspublic:
1656     // 0 - Students can only see their own ratings
1657     // 1 - Students can see everyone's ratings
1658     switch ($data->assesspublic) {
1659         case 0:
1660             foreach ($studentroles as $studentrole) {
1661                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1662             }
1663             foreach ($teacherroles as $teacherrole) {
1664                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1665             }
1666             break;
1667         case 1:
1668             foreach ($studentroles as $studentrole) {
1669                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1670             }
1671             foreach ($teacherroles as $teacherrole) {
1672                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1673             }
1674             break;
1675     }
1677     if (empty($cm)) {
1678         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1679     }
1681     switch ($cm->groupmode) {
1682         case NOGROUPS:
1683             break;
1684         case SEPARATEGROUPS:
1685             foreach ($studentroles as $studentrole) {
1686                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1687             }
1688             foreach ($teacherroles as $teacherrole) {
1689                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1690             }
1691             break;
1692         case VISIBLEGROUPS:
1693             foreach ($studentroles as $studentrole) {
1694                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1695             }
1696             foreach ($teacherroles as $teacherrole) {
1697                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1698             }
1699             break;
1700     }
1701     return true;
1704 /*
1705  * Returns the best name to show for a preset
1706  */
1707 function data_preset_name($shortname, $path) {
1709     // We are looking inside the preset itself as a first choice, but also in normal data directory
1710     $string = get_string('modulename', 'datapreset_'.$shortname);
1712     if (substr($string, 0, 1) == '[') {
1713         return $shortname;
1714     } else {
1715         return $string;
1716     }
1719 /*
1720  * Returns an array of all the available presets
1721  */
1722 function data_get_available_presets($context) {
1723     global $CFG, $USER;
1725     $presets = array();
1727     if ($dirs = get_list_of_plugins('mod/data/preset')) {
1728         foreach ($dirs as $dir) {
1729             $fulldir = $CFG->dirroot.'/mod/data/preset/'.$dir;
1731             if (is_directory_a_preset($fulldir)) {
1732                 $preset = new object;
1733                 $preset->path = $fulldir;
1734                 $preset->userid = 0;
1735                 $preset->shortname = $dir;
1736                 $preset->name = data_preset_name($dir, $fulldir);
1737                 if (file_exists($fulldir.'/screenshot.jpg')) {
1738                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1739                 } else if (file_exists($fulldir.'/screenshot.png')) {
1740                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1741                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1742                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1743                 }
1744                 $presets[] = $preset;
1745             }
1746         }
1747     }
1749     if ($userids = get_list_of_plugins('data/preset', '', $CFG->dataroot)) {
1750         foreach ($userids as $userid) {
1751             $fulldir = $CFG->dataroot.'/data/preset/'.$userid;
1753             if ($userid == 0 || $USER->id == $userid || has_capability('mod/data:viewalluserpresets', $context)) {
1755                 if ($dirs = get_list_of_plugins('data/preset/'.$userid, '', $CFG->dataroot)) {
1756                     foreach ($dirs as $dir) {
1757                         $fulldir = $CFG->dataroot.'/data/preset/'.$userid.'/'.$dir;
1759                         if (is_directory_a_preset($fulldir)) {
1760                             $preset = new object;
1761                             $preset->path = $fulldir;
1762                             $preset->userid = $userid;
1763                             $preset->shortname = $dir;
1764                             $preset->name = data_preset_name($dir, $fulldir);
1765                             if (file_exists($fulldir.'/screenshot.jpg')) {
1766                                 $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1767                             } else if (file_exists($fulldir.'/screenshot.png')) {
1768                                 $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1769                             } else if (file_exists($fulldir.'/screenshot.gif')) {
1770                                 $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1771                             }
1772                             $presets[] = $preset;
1773                         }
1774                     }
1775                 }
1776             }
1777         }
1778     }
1780     return $presets;
1784 function data_print_header($course, $cm, $data, $currenttab='') {
1786     global $CFG, $displaynoticegood, $displaynoticebad;
1788     $navigation = build_navigation('', $cm);
1789     print_header_simple($data->name, '', $navigation,
1790             '', '', true, update_module_button($cm->id, $course->id, get_string('modulename', 'data')),
1791             navmenu($course, $cm));
1793     print_heading(format_string($data->name));
1795 // Groups needed for Add entry tab
1796     $currentgroup = groups_get_activity_group($cm);
1797     $groupmode = groups_get_activity_groupmode($cm);
1799     // Print the tabs
1801     if ($currenttab) {
1802         include('tabs.php');
1803     }
1805     // Print any notices
1807     if (!empty($displaynoticegood)) {
1808         notify($displaynoticegood, 'notifysuccess');    // good (usually green)
1809     } else if (!empty($displaynoticebad)) {
1810         notify($displaynoticebad);                     // bad (usuually red)
1811     }
1814 function data_user_can_add_entry($data, $currentgroup, $groupmode) {
1815     global $USER;
1817     if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1818         print_error('invalidcoursemodule');
1819     }
1820     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1822     if (!has_capability('mod/data:writeentry', $context) and !has_capability('mod/data:manageentries',$context)) {
1823         return false;
1824     }
1826     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
1827         return true;
1828     }
1830     if ($currentgroup) {
1831         return groups_is_member($currentgroup);
1832     } else {
1833         //else it might be group 0 in visible mode
1834         if ($groupmode == VISIBLEGROUPS){
1835             return true;
1836         } else {
1837             return false;
1838         }
1839     }
1843 function is_directory_a_preset($directory) {
1844     $directory = rtrim($directory, '/\\') . '/';
1845     $status = file_exists($directory.'singletemplate.html') &&
1846               file_exists($directory.'listtemplate.html') &&
1847               file_exists($directory.'listtemplateheader.html') &&
1848               file_exists($directory.'listtemplatefooter.html') &&
1849               file_exists($directory.'addtemplate.html') &&
1850               file_exists($directory.'rsstemplate.html') &&
1851               file_exists($directory.'rsstitletemplate.html') &&
1852               file_exists($directory.'csstemplate.css') &&
1853               file_exists($directory.'jstemplate.js') &&
1854               file_exists($directory.'preset.xml');
1856     return $status;
1860 function clean_preset($folder) {
1861     $status = @unlink($folder.'/singletemplate.html') &&
1862               @unlink($folder.'/listtemplate.html') &&
1863               @unlink($folder.'/listtemplateheader.html') &&
1864               @unlink($folder.'/listtemplatefooter.html') &&
1865               @unlink($folder.'/addtemplate.html') &&
1866               @unlink($folder.'/rsstemplate.html') &&
1867               @unlink($folder.'/rsstitletemplate.html') &&
1868               @unlink($folder.'/csstemplate.css') &&
1869               @unlink($folder.'/jstemplate.js') &&
1870               @unlink($folder.'/preset.xml');
1872     // optional
1873     @unlink($folder.'/asearchtemplate.html');
1875     return $status;
1879 class PresetImporter {
1880     function PresetImporter($course, $cm, $data, $userid, $shortname) {
1881         global $CFG;
1882         $this->course = $course;
1883         $this->cm = $cm;
1884         $this->data = $data;
1885         $this->userid = $userid;
1886         $this->shortname = $shortname;
1887         $this->folder = data_preset_path($course, $userid, $shortname);
1888     }
1890     function get_settings() {
1891         global $CFG, $DB;
1893         if (!is_directory_a_preset($this->folder)) {
1894             print_error('invalidpreset', 'data', '', $this->userid.'/'.$this->shortname);
1895         }
1897         /* Grab XML */
1898         $presetxml = file_get_contents($this->folder.'/preset.xml');
1899         $parsedxml = xmlize($presetxml, 0);
1901         $allowed_settings = array('intro', 'comments', 'requiredentries', 'requiredentriestoview',
1902                                   'maxentries', 'rssarticles', 'approval', 'defaultsortdir', 'defaultsort');
1904         /* First, do settings. Put in user friendly array. */
1905         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
1906         $settings = new StdClass();
1908         foreach ($settingsarray as $setting => $value) {
1909             if (!is_array($value)) {
1910                 continue;
1911             }
1912             if (!in_array($setting, $allowed_settings)) {
1913                 // unsupported setting
1914                 continue;
1915             }
1916             $settings->$setting = $value[0]['#'];
1917         }
1919         /* Now work out fields to user friendly array */
1920         $fieldsarray = $parsedxml['preset']['#']['field'];
1921         $fields = array();
1922         foreach ($fieldsarray as $field) {
1923             if (!is_array($field)) {
1924                 continue;
1925             }
1926             $f = new StdClass();
1927             foreach ($field['#'] as $param => $value) {
1928                 if (!is_array($value)) {
1929                     continue;
1930                 }
1931                 $f->$param = $value[0]['#'];
1932             }
1933             $f->dataid = $this->data->id;
1934             $f->type = clean_param($f->type, PARAM_ALPHA);
1935             $fields[] = $f;
1936         }
1937         /* Now add the HTML templates to the settings array so we can update d */
1938         $settings->singletemplate     = file_get_contents($this->folder."/singletemplate.html");
1939         $settings->listtemplate       = file_get_contents($this->folder."/listtemplate.html");
1940         $settings->listtemplateheader = file_get_contents($this->folder."/listtemplateheader.html");
1941         $settings->listtemplatefooter = file_get_contents($this->folder."/listtemplatefooter.html");
1942         $settings->addtemplate        = file_get_contents($this->folder."/addtemplate.html");
1943         $settings->rsstemplate        = file_get_contents($this->folder."/rsstemplate.html");
1944         $settings->rsstitletemplate   = file_get_contents($this->folder."/rsstitletemplate.html");
1945         $settings->csstemplate        = file_get_contents($this->folder."/csstemplate.css");
1946         $settings->jstemplate         = file_get_contents($this->folder."/jstemplate.js");
1948         //optional
1949         if (file_exists($this->folder."/asearchtemplate.html")) {
1950             $settings->asearchtemplate = file_get_contents($this->folder."/asearchtemplate.html");
1951         } else {
1952             $settings->asearchtemplate = NULL;
1953         }
1955         $settings->instance = $this->data->id;
1957         /* Now we look at the current structure (if any) to work out whether we need to clear db
1958            or save the data */
1959         if (!$currentfields = $DB->get_records('data_fields', array('dataid'=>$this->data->id))) {
1960             $currentfields = array();
1961         }
1963         return array($settings, $fields, $currentfields);
1964     }
1966     function import_options() {
1967         if (!confirm_sesskey()) {
1968             print_error('invalidsesskey');
1969         }
1971         $strblank = get_string('blank', 'data');
1972         $strcontinue = get_string('continue');
1973         $strwarning = get_string('mappingwarning', 'data');
1974         $strfieldmappings = get_string('fieldmappings', 'data');
1975         $strnew = get_string('new');
1977         $sesskey = sesskey();
1979         list($settings, $newfields,  $currentfields) = $this->get_settings();
1981         echo '<div class="presetmapping"><form action="preset.php" method="post">';
1982         echo '<div>';
1983         echo '<input type="hidden" name="action" value="finishimport" />';
1984         echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
1985         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />';
1986         echo '<input type="hidden" name="fullname" value="'.$this->userid.'/'.$this->shortname.'" />';
1988         if (!empty($currentfields) && !empty($newfields)) {
1989             echo "<h3>$strfieldmappings ";
1990             helpbutton('fieldmappings', $strfieldmappings, 'data');
1991             echo '</h3><table>';
1993             foreach ($newfields as $nid => $newfield) {
1994                 echo "<tr><td><label for=\"id_$newfield->name\">$newfield->name</label></td>";
1995                 echo '<td><select name="field_'.$nid.'" id="id_'.$newfield->name.'">';
1997                 $selected = false;
1998                 foreach ($currentfields as $cid => $currentfield) {
1999                     if ($currentfield->type == $newfield->type) {
2000                         if ($currentfield->name == $newfield->name) {
2001                             echo '<option value="'.$cid.'" selected="selected">'.$currentfield->name.'</option>';
2002                             $selected=true;
2003                         }
2004                         else {
2005                             echo '<option value="'.$cid.'">'.$currentfield->name.'</option>';
2006                         }
2007                     }
2008                 }
2010                 if ($selected)
2011                     echo '<option value="-1">-</option>';
2012                 else
2013                     echo '<option value="-1" selected="selected">-</option>';
2014                 echo '</select></td></tr>';
2015             }
2016             echo '</table>';
2017             echo "<p>$strwarning</p>";
2019         } else if (empty($newfields)) {
2020             print_error('nodefinedfields', 'data');
2021         }
2023         echo '<div class="overwritesettings"><label for="overwritesettings">'.get_string('overwritesettings', 'data');
2024         echo '<input id="overwritesettings" name="overwritesettings" type="checkbox" /></label></div>';
2026         echo '<input class="button" type="submit" value="'.$strcontinue.'" /></div></form></div>';
2028     }
2030     function import() {
2031         global $CFG, $DB;
2033         list($settings, $newfields, $currentfields) = $this->get_settings();
2034         $preservedfields = array();
2036         $overwritesettings = optional_param('overwritesettings', 0, PARAM_BOOL);
2038         /* Maps fields and makes new ones */
2039         if (!empty($newfields)) {
2040             /* We require an injective mapping, and need to know what to protect */
2041             foreach ($newfields as $nid => $newfield) {
2042                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2043                 if ($cid == -1) continue;
2045                 if (array_key_exists($cid, $preservedfields)){
2046                     print_error('notinjectivemap', 'data');
2047                 }
2048                 else $preservedfields[$cid] = true;
2049             }
2051             foreach ($newfields as $nid => $newfield) {
2052                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2054                 /* A mapping. Just need to change field params. Data kept. */
2055                 if ($cid != -1 and isset($currentfields[$cid])) {
2056                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->data);
2057                     foreach ($newfield as $param => $value) {
2058                         if ($param != "id") {
2059                             $fieldobject->field->$param = $value;
2060                         }
2061                     }
2062                     unset($fieldobject->field->similarfield);
2063                     $fieldobject->update_field();
2064                     unset($fieldobject);
2065                 }
2066                 /* Make a new field */
2067                 else {
2068                     include_once("field/$newfield->type/field.class.php");
2070                     if (!isset($newfield->description)) {
2071                         $newfield->description = '';
2072                     }
2073                     $classname = 'data_field_'.$newfield->type;
2074                     $fieldclass = new $classname($newfield, $this->data);
2075                     $fieldclass->insert_field();
2076                     unset($fieldclass);
2077                 }
2078             }
2079         }
2081         /* Get rid of all old unused data */
2082         if (!empty($preservedfields)) {
2083             foreach ($currentfields as $cid => $currentfield) {
2084                 if (!array_key_exists($cid, $preservedfields)) {
2085                     /* Data not used anymore so wipe! */
2086                     print "Deleting field $currentfield->name<br />";
2088                     $id = $currentfield->id;
2089                     //Why delete existing data records and related comments/ratings??
2090 /*
2091                     if ($content = $DB->get_records('data_content', array('fieldid'=>$id))) {
2092                         foreach ($content as $item) {
2093                             $DB->delete_records('data_ratings', array('recordid'=>$item->recordid));
2094                             $DB->delete_records('data_comments', array('recordid'=>$item->recordid));
2095                             $DB->delete_records('data_records', array('id'=>$item->recordid));
2096                         }
2097                     }*/
2098                     $DB->delete_records('data_content', array('fieldid'=>$id));
2099                     $DB->delete_records('data_fields', array('id'=>$id));
2100                 }
2101             }
2102         }
2104     // handle special settings here
2105         if (!empty($settings->defaultsort)) {
2106             if (is_numeric($settings->defaultsort)) {
2107                 // old broken value
2108                 $settings->defaultsort = 0;
2109             } else {
2110                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->data->id, 'name'=>$settings->defaultsort));
2111             }
2112         } else {
2113             $settings->defaultsort = 0;
2114         }
2116         // do we want to overwrite all current database settings?
2117         if ($overwritesettings) {
2118             // all supported settings
2119             $overwrite = array_keys((array)$settings);
2120         } else {
2121             // only templates and sorting
2122             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2123                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2124                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2125         }
2127         // now overwrite current data settings
2128         foreach ($this->data as $prop=>$unused) {
2129             if (in_array($prop, $overwrite)) {
2130                 $this->data->$prop = $settings->$prop;
2131             }
2132         }
2134         data_update_instance($this->data);
2136         if (strstr($this->folder, '/temp/')) {
2137         // Removes the temporary files
2138             clean_preset($this->folder);
2139         }
2141         return true;
2142     }
2145 function data_preset_path($course, $userid, $shortname) {
2146     global $USER, $CFG;
2148     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2150     $userid = (int)$userid;
2152     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2153         return $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2154     } else if ($userid == 0) {
2155         return $CFG->dirroot.'/mod/data/preset/'.$shortname;
2156     } else if ($userid < 0) {
2157         return $CFG->dataroot.'/temp/data/'.-$userid.'/'.$shortname;
2158     }
2160     return 'Does it disturb you that this code will never run?';
2163 /**
2164  * Implementation of the function for printing the form elements that control
2165  * whether the course reset functionality affects the data.
2166  * @param $mform form passed by reference
2167  */
2168 function data_reset_course_form_definition(&$mform) {
2169     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2170     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2172     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2173     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2175     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2176     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2178     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2179     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2182 /**
2183  * Course reset form defaults.
2184  */
2185 function data_reset_course_form_defaults($course) {
2186     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2189 /**
2190  * Removes all grades from gradebook
2191  * @param int $courseid
2192  * @param string optional type
2193  */
2194 function data_reset_gradebook($courseid, $type='') {
2195     global $CFG, $DB;
2197     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2198               FROM {data} d, {course_modules} cm, {modules} m
2199              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2201     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2202         foreach ($datas as $data) {
2203             data_grade_item_update($data, 'reset');
2204         }
2205     }
2208 /**
2209  * Actual implementation of the rest coures functionality, delete all the
2210  * data responses for course $data->courseid.
2211  * @param $data the data submitted from the reset course.
2212  * @return array status array
2213  */
2214 function data_reset_userdata($data) {
2215     global $CFG, $DB;
2216     require_once($CFG->libdir.'/filelib.php');
2218     $componentstr = get_string('modulenameplural', 'data');
2219     $status = array();
2221     $allrecordssql = "SELECT r.id
2222                         FROM {data_records} r
2223                              INNER JOIN {data} d ON r.dataid = d.id
2224                        WHERE d.course = ?";
2226     $alldatassql = "SELECT d.id
2227                       FROM {data} d
2228                      WHERE d.course=?";
2230     // delete entries if requested
2231     if (!empty($data->reset_data)) {
2232         $DB->delete_records_select('data_ratings', "recordid IN ($allrecordssql)", array($data->courseid));
2233         $DB->delete_records_select('data_comments', "recordid IN ($allrecordssql)", array($data->courseid));
2234         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2235         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2237         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2238             foreach ($datas as $dataid=>$unused) {
2239                 fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$dataid");
2240             }
2241         }
2243         if (empty($data->reset_gradebook_grades)) {
2244             // remove all grades from gradebook
2245             data_reset_gradebook($data->courseid);
2246         }
2247         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2248     }
2250     // remove entries by users not enrolled into course
2251     if (!empty($data->reset_data_notenrolled)) {
2252         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2253                          FROM {data_records} r
2254                               JOIN {data} d ON r.dataid = d.id
2255                               LEFT JOIN {user} u ON r.userid = u.id
2256                         WHERE d.course = ? AND r.userid > 0";
2258         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2259         $notenrolled = array();
2260         $fields = array();
2261         if ($rs = $DB->get_recordset_sql($recordssql, array($data->courseid))) {
2262             foreach ($rs as $record) {
2263                 if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2264                   or !has_capability('moodle/course:view', $course_context , $record->userid)) {
2265                     $DB->delete_records('data_ratings', array('recordid'=>$record->id));
2266                     $DB->delete_records('data_comments', array('recordid'=>$record->id));
2267                     $DB->delete_records('data_content', array('recordid'=>$record->id));
2268                     $DB->delete_records('data_records', array('id'=>$record->id));
2269                     // HACK: this is ugly - the recordid should be before the fieldid!
2270                     if (!array_key_exists($record->dataid, $fields)) {
2271                         if ($fs = $DB->get_records('data_fields', array('dataid'=>$record->dataid))) {
2272                             $fields[$record->dataid] = array_keys($fs);
2273                         } else {
2274                             $fields[$record->dataid] = array();
2275                         }
2276                     }
2277                     foreach($fields[$record->dataid] as $fieldid) {
2278                         fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$record->dataid/$fieldid/$record->id");
2279                     }
2280                     $notenrolled[$record->userid] = true;
2281                 }
2282             }
2283             $rs->close();
2284             $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2285         }
2286     }
2288     // remove all ratings
2289     if (!empty($data->reset_data_ratings)) {
2290         $DB->delete_records_select('data_ratings', "recordid IN ($allrecordssql)", array($data->courseid));
2292         if (empty($data->reset_gradebook_grades)) {
2293             // remove all grades from gradebook
2294             data_reset_gradebook($data->courseid);
2295         }
2297         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2298     }
2300     // remove all comments
2301     if (!empty($data->reset_data_comments)) {
2302         $DB->delete_records_select('data_comments', "recordid IN ($allrecordssql)", array($data->courseid));
2303         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2304     }
2306     // updating dates - shift may be negative too
2307     if ($data->timeshift) {
2308         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2309         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2310     }
2312     return $status;
2315 /**
2316  * Returns all other caps used in module
2317  */
2318 function data_get_extra_capabilities() {
2319     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
2322 /**
2323  * @param string $feature FEATURE_xx constant for requested feature
2324  * @return mixed True if module supports feature, null if doesn't know
2325  */
2326 function data_supports($feature) {
2327     switch($feature) {
2328         case FEATURE_GROUPS:                  return true;
2329         case FEATURE_GROUPINGS:               return true;
2330         case FEATURE_GROUPMEMBERSONLY:        return true;
2331         case FEATURE_MODEDIT_INTRO_EDITOR:    return true;
2332         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2333         case FEATURE_GRADE_HAS_GRADE:         return true;
2334         case FEATURE_GRADE_OUTCOMES:          return true;
2336         default: return null;
2337             }
2339 function data_export_csv($export, $delimiter_name, $dataname, $count, $return=false) {
2340     global $CFG;
2341     require_once($CFG->libdir . '/csvlib.class.php');
2342     $delimiter = csv_import_reader::get_delimiter($delimiter_name);
2343     $filename = clean_filename("${dataname}-${count}_record");
2344     if ($count > 1) {
2345         $filename .= 's';
2346     }
2347     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2348     $filename .= clean_filename("-${delimiter_name}_separated");
2349     $filename .= '.csv';
2350     if (empty($return)) {
2351         header("Content-Type: application/download\n");
2352         header("Content-Disposition: attachment; filename=$filename");
2353         header('Expires: 0');
2354         header('Cache-Control: must-revalidate,post-check=0,pre-check=0');
2355         header('Pragma: public');
2356     }
2357     $encdelim = '&#' . ord($delimiter) . ';';
2358     $returnstr = '';
2359     foreach($export as $row) {
2360         foreach($row as $key => $column) {
2361             $row[$key] = str_replace($delimiter, $encdelim, $column);
2362         }
2363         $returnstr .= implode($delimiter, $row) . "\n";
2364     }
2365     if (empty($return)) {
2366         echo $returnstr;
2367         return;
2368     }
2369     return $returnstr;
2373 function data_export_xls($export, $dataname, $count) {
2374     global $CFG;
2375     require_once("$CFG->libdir/excellib.class.php");
2376     $filename = clean_filename("${dataname}-${count}_record");
2377     if ($count > 1) {
2378         $filename .= 's';
2379     }
2380     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2381     $filename .= '.xls';
2383     $filearg = '-';
2384     $workbook = new MoodleExcelWorkbook($filearg);
2385     $workbook->send($filename);
2386     $worksheet = array();
2387     $worksheet[0] =& $workbook->add_worksheet('');
2388     $rowno = 0;
2389     foreach ($export as $row) {
2390         $colno = 0;
2391         foreach($row as $col) {
2392             $worksheet[0]->write($rowno, $colno, $col);
2393             $colno++;
2394         }
2395         $rowno++;
2396     }
2397     $workbook->close();
2398     return $filename;
2402 function data_export_ods($export, $dataname, $count) {
2403     global $CFG;
2404     require_once("$CFG->libdir/odslib.class.php");
2405     $filename = clean_filename("${dataname}-${count}_record");
2406     if ($count > 1) {
2407         $filename .= 's';
2408     }
2409     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2410     $filename .= '.ods';
2411     $filearg = '-';
2412     $workbook = new MoodleODSWorkbook($filearg);
2413     $workbook->send($filename);
2414     $worksheet = array();
2415     $worksheet[0] =& $workbook->add_worksheet('');
2416     $rowno = 0;
2417     foreach ($export as $row) {
2418         $colno = 0;
2419         foreach($row as $col) {
2420             $worksheet[0]->write($rowno, $colno, $col);
2421             $colno++;
2422         }
2423         $rowno++;
2424     }
2425     $workbook->close();
2426     return $filename;
2429 function data_get_exportdata($dataid, $fields, $selectedfields) {
2430     global $DB;
2432     $exportdata = array();
2434     // populate the header in first row of export
2435     foreach($fields as $key => $field) {
2436         if (!in_array($field->field->id, $selectedfields)) {
2437             // ignore values we aren't exporting
2438             unset($fields[$key]);
2439         } else {
2440             $exportdata[0][] = $field->field->name;
2441         }
2442     }
2444     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2445     ksort($datarecords);
2446     $line = 1;
2447     foreach($datarecords as $record) {
2448         // get content indexed by fieldid
2449         if( $content = $DB->get_records('data_content', array('recordid'=>$record->id), 'fieldid', 'fieldid, content, content1, content2, content3, content4') ) {
2450             foreach($fields as $field) {
2451                 $contents = '';
2452                 if(isset($content[$field->field->id])) {
2453                     $contents = $field->export_text_value($content[$field->field->id]);
2454                 }
2455                 $exportdata[$line][] = $contents;
2456             }
2457         }
2458         $line++;
2459     }
2460     $line--;
2461     return $exportdata;
2464 /**
2465  * Lists all browsable file areas
2466  */
2467 function data_get_file_areas($course, $cm, $context) {
2468     $areas = array();
2469     if (has_capability('moodle/course:managefiles', $context)) {
2470         $areas['data_intro'] = get_string('areaintro', 'data');
2471     }
2472     return $areas;
2475 /**
2476  * Serves the data attachments. Implements needed access control ;-)
2477  */
2478 function data_pluginfile($course, $cminfo, $context, $filearea, $args) {
2479     global $CFG, $DB;
2481     if (!$cminfo->uservisible) {
2482         return false;
2483     }
2485     if ($filearea === 'data_intro') {
2486         // all users may access it
2487         $relativepath = '/'.implode('/', $args);
2488         $fullpath = $context->id.'data_intro0'.$relativepath;
2490         $fs = get_file_storage();
2491         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2492             return false;
2493         }
2495         $lifetime = isset($CFG->filelifetime) ? $CFG->filelifetime : 86400;
2497         // finally send the file
2498         send_stored_file($file, $lifetime, 0);
2500     } else if ($filearea === 'data_content') {
2501         $contentid = (int)array_shift($args);
2503         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
2504             return false;
2505         }
2507         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2508             return false;
2509         }
2511         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2512             return false;
2513         }
2515         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2516             return false;
2517         }
2519         //check if approved
2520         if (!$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2521             return false;
2522         }
2524         // group access
2525         if ($record->groupid) {
2526             $groupmode = groups_get_activity_groupmode($cminfo, $course);
2527             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2528                 if (!groups_is_member($record->groupid)) {
2529                     return false;
2530                 }
2531             }
2532         }
2534         $fieldobj = data_get_field($field, $data, $cminfo);
2536         $relativepath = '/'.implode('/', $args);
2537         $fullpath = $context->id.'data_content'.$content->id.$relativepath;
2539         if (!$fieldobj->file_ok($relativepath)) {
2540             return false;
2541         }
2543         $fs = get_file_storage();
2544         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2545             return false;
2546         }
2548         // finally send the file
2549         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
2550     }
2552     return false;
2555 class data_portfolio_caller extends portfolio_module_caller_base {
2557     protected $recordid;
2558     protected $exporttype;
2559     protected $delimiter_name;
2561     private $data;
2562     private $selectedfields;
2563     private $fields;
2564     private $fieldtypes;
2565     private $exportdata;
2566     private $singlerecord;
2567     private $singlefield;
2569     public static function expected_callbackargs() {
2570         return array(
2571             'id'             => true,
2572             'recordid'       => false,
2573             'delimiter_name' => false,
2574             'exporttype'     => false,
2575         );
2576     }
2578     public function __construct($callbackargs) {
2579         parent::__construct($callbackargs);
2580         if (empty($this->exporttype)) {
2581             $this->exporttype = 'csv';
2582         }
2583         $this->selectedfields = array();
2584         foreach ($callbackargs as $key => $value) {
2585             if (strpos($key, 'field_') === 0) {
2586                 $this->selectedfields[] = substr($key, 6);
2587             }
2588         }
2589     }
2591     public function load_data() {
2592         global $DB;
2593         if (!$this->cm = get_coursemodule_from_id('data', $this->id)) {
2594             throw new portfolio_caller_exception('invalidid', 'data');
2595         }
2596         $this->data = $DB->get_record('data', array('id' => $this->cm->instance));
2597         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$this->cm->instance), 'id');
2598         // populate objets for this databases fields
2599         $this->fields = array();
2600         foreach ($fieldrecords as $fieldrecord) {
2601             $tmp = data_get_field($fieldrecord, $this->data);
2602             $this->fields[] = $tmp;
2603             $this->fieldtypes[]  = $tmp->type;
2604         }
2606         if ($this->recordid) {
2607             //user has selected to export one single entry rather than the whole thing
2608             // which is completely different
2609             $this->singlerecord = $DB->get_record('data_records', array('id' => $this->recordid));
2610             $this->singlerecord->content = $DB->get_records('data_content', array('recordid' => $this->singlerecord->id));
2611             $this->exporttype = 'single';
2613             list($formats, $files) = self::formats($this->fields, $this->singlerecord);
2614             $this->supportedformats = $formats;
2615             if (count($files) == 1 && count($this->fields) == 1) {
2616                 $this->singlefile = $files[0];
2617                 $this->exporttype = 'singlefile';
2618             } else if (count($files) > 0) {
2619                 $this->multifiles = $files;
2620             }
2621         } else {
2622             // all records as csv or whatever
2623             $this->exportdata = data_get_exportdata($this->cm->instance, $this->fields, $this->selectedfields);
2624         }
2625     }
2627     public function has_export_config() {
2628         // @todo penny  later when we suport exporting to more than just csv, we may need to ask the user here
2629         // if we have not already passed it
2630         return false;
2631     }
2633     public function expected_time() {
2634         if ($this->exporttype == 'single') {
2635             return PORTFOLIO_TIME_LOW;
2636         }
2637         return portfolio_expected_time_db(count($this->exportdata));
2638     }
2640     public function get_sha1() {
2641         if ($this->exporttype == 'singlefile') {
2642             return $this->singlefile->get_contenthash();
2643         }
2644         $loopdata = $this->exportdata;
2645         if ($this->exporttype == 'single') {
2646             $loopdata = $this->singlerecord;
2647         }
2648         $str = '';
2649         foreach ($loopdata as $data) {
2650             if (is_array($data) || is_object($data)) {
2651                 $testkey = array_pop(array_keys($data));
2652                 if (is_array($data[$testkey]) || is_object($data[$testkey])) {
2653                     foreach ($data as $d) {
2654                         $str .= implode(',', (array)$d);
2655                     }
2656                 } else {
2657                     $str .= implode(',', (array)$data);
2658                 }
2659             } else {
2660                 $str .= $data;
2661             }
2662         }
2663         return sha1($str . ',' . $this->exporttype);
2664     }
2666     public function prepare_package() {
2667         global $DB;
2668         $count = count($this->exportdata);
2669         $content = '';
2670         $filename = '';
2671         switch ($this->exporttype) {
2672             case 'singlefile':
2673                 return $this->get('exporter')->copy_existing_file($this->singlefile);
2674             case 'single':
2675                 $content = $this->exportsingle();
2676                 $filename = clean_filename($this->cm->name . '-entry.html');
2677                 break;
2678             case 'csv':
2679                 $content = data_export_csv($this->exportdata, $this->delimiter_name, $this->cm->name, $count, true);
2680                 $filename = clean_filename($this->cm->name . '.csv');
2681                 break;
2682             case 'xls':
2683                 throw new portfolio_caller_exception('notimplemented', 'portfolio', '', 'xls');
2684                 $content = data_export_xls($this->exportdata, $this->cm->name, $count, true);
2685                 break;
2686             case 'ods':
2687                 throw new portfolio_caller_exception('notimplemented', 'portfolio', '', 'ods');
2688                 $content = data_export_ods($this->exportdata, $this->cm->name, $count, true);
2689                 break;
2690             default:
2691                 throw new portfolio_caller_exception('notimplemented', 'portfolio', '', $this->exporttype);
2692             break;
2693         }
2694         return $this->exporter->write_new_file(
2695             $content,
2696             $filename,
2697             ($this->exporter->get('format') instanceof PORTFOLIO_FORMAT_RICH) // if we have associate files, this is a 'manifest'
2698         );
2699     }
2701     public function check_permissions() {
2702         return has_capability('mod/data:exportallentries', get_context_instance(CONTEXT_MODULE, $this->cm->id));
2703     }
2705     public static function display_name() {
2706         return get_string('modulename', 'data');
2707     }
2709     public function __wakeup() {
2710         global $CFG;
2711         if (empty($CFG)) {
2712             return true; // too early yet
2713         }
2714         foreach ($this->fieldtypes as $key => $field) {
2715             require_once($CFG->dirroot . '/mod/data/field/' . $field .'/field.class.php');
2716             $this->fields[$key] = unserialize(serialize($this->fields[$key]));
2717         }
2718     }
2720     private function exportsingle() {
2721         global $DB;
2722     // Replacing tags
2723         $patterns = array();
2724         $replacement = array();
2725         $context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
2727     // Then we generate strings to replace for normal tags
2728         $format = $this->get('exporter')->get('format');
2729         foreach ($this->fields as $field) {
2730             $patterns[]='[['.$field->field->name.']]';
2731             if (is_callable(array($field, 'get_file'))) {
2732                 // TODO this used to be:
2733                 // if ($field instanceof data_field_file) {
2734                 // - see  MDL-16493
2735                 if (!$file = $field->get_file($this->singlerecord->id)) {
2736                     $replacement[] = '';
2737                     continue; // probably left empty
2738                 }
2739                 $replacement[] = $format->file_output($file);
2740                 $this->get('exporter')->copy_existing_file($file);
2741             } else {
2742                 $replacement[] = $field->display_browse_field($this->singlerecord->id, 'singletemplate');
2743             }
2744         }
2746     // Replacing special tags (##Edit##, ##Delete##, ##More##)
2747         $patterns[]='##edit##';
2748         $patterns[]='##delete##';
2749         $patterns[]='##export##';
2750         $patterns[]='##more##';
2751         $patterns[]='##moreurl##';
2752         $patterns[]='##user##';
2753         $patterns[]='##approve##';
2754         $patterns[]='##comments##';
2755         $patterns[] = '##timeadded##';
2756         $patterns[] = '##timemodified##';
2757         $replacement[] = '';
2758         $replacement[] = '';
2759         $replacement[] = '';
2760         $replacement[] = '';
2761         $replacement[] = '';
2762         $replacement[] = '';
2763         $replacement[] = '';
2764         $replacement[] = '';
2765         $replacement[] = userdate($this->singlerecord->timecreated);
2766         $replacement[] = userdate($this->singlerecord->timemodified);
2768         // actual replacement of the tags
2769         return str_ireplace($patterns, $replacement, $this->data->singletemplate);
2770     }
2772     public static function formats($fields, $record) {
2773         $formats = array(PORTFOLIO_FORMAT_PLAINHTML);
2774         $includedfiles = array();
2775         foreach ($fields as $singlefield) {
2776             if (is_callable(array($singlefield, 'get_file'))) {
2777                 $includedfiles[] = $singlefield->get_file($record->id);
2778             }
2779         }
2780         if (count($includedfiles) == 1 && count($fields) == 1) {
2781             $formats= array(portfolio_format_from_file($includedfiles[0]));
2782         } else if (count($includedfiles) > 0) {
2783             $formats = array(PORTFOLIO_FORMAT_FILE, PORTFOLIO_FORMAT_RICHHTML);
2784         }
2785         return array($formats, $includedfiles);
2786     }
2788 ?>