mod/data/lib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * @package   mod-data
  20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22  */
  23
  24 // Some constants
  25 define ('DATA_MAX_ENTRIES', 50);
  26 define ('DATA_PERPAGE_SINGLE', 1);
  27
  28 define ('DATA_FIRSTNAME', -1);
  29 define ('DATA_LASTNAME', -2);
  30 define ('DATA_APPROVED', -3);
  31 define ('DATA_TIMEADDED', 0);
  32 define ('DATA_TIMEMODIFIED', -4);
  33
  34 define ('DATA_CAP_EXPORT', 'mod/data:viewalluserpresets');
  35
  36 define('DATA_PRESET_COMPONENT', 'mod_data');
  37 define('DATA_PRESET_FILEAREA', 'site_presets');
  38 define('DATA_PRESET_CONTEXT', SYSCONTEXTID);
  39
  40 // Users having assigned the default role "Non-editing teacher" can export database records
  41 // Using the mod/data capability "viewalluserpresets" existing in Moodle 1.9.x.
  42 // In Moodle >= 2, new roles may be introduced and used instead.
  43
  44 /**
  45  * @package   mod-data
  46  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  47  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  48  */
  49 class data_field_base {     // Base class for Database Field Types (see field/*/field.class.php)
  50
  51     /** @var string Subclasses must override the type with their name */
  52     var $type = 'unknown';
  53     /** @var object The database object that this field belongs to */
  54     var $data = NULL;
  55     /** @var object The field object itself, if we know it */
  56     var $field = NULL;
  57     /** @var int Width of the icon for this fieldtype */
  58     var $iconwidth = 16;
  59     /** @var int Width of the icon for this fieldtype */
  60     var $iconheight = 16;
  61     /** @var object course module or cmifno */
  62     var $cm;
  63     /** @var object activity context */
  64     var $context;
  65
  66     /**
  67      * Constructor function
  68      *
  69      * @global object
  70      * @uses CONTEXT_MODULE
  71      * @param int $field
  72      * @param int $data
  73      * @param int $cm
  74      */
  75     function __construct($field=0, $data=0, $cm=0) {   // Field or data or both, each can be id or object
  76         global $DB;
  77
  78         if (empty($field) && empty($data)) {
  79             print_error('missingfield', 'data');
  80         }
  81
  82         if (!empty($field)) {
  83             if (is_object($field)) {
  84                 $this->field = $field;  // Programmer knows what they are doing, we hope
  85             } else if (!$this->field = $DB->get_record('data_fields', array('id'=>$field))) {
  86                 print_error('invalidfieldid', 'data');
  87             }
  88             if (empty($data)) {
  89                 if (!$this->data = $DB->get_record('data', array('id'=>$this->field->dataid))) {
  90                     print_error('invalidid', 'data');
  91                 }
  92             }
  93         }
  94
  95         if (empty($this->data)) {         // We need to define this properly
  96             if (!empty($data)) {
  97                 if (is_object($data)) {
  98                     $this->data = $data;  // Programmer knows what they are doing, we hope
  99                 } else if (!$this->data = $DB->get_record('data', array('id'=>$data))) {
 100                     print_error('invalidid', 'data');
 101                 }
 102             } else {                      // No way to define it!
 103                 print_error('missingdata', 'data');
 104             }
 105         }
 106
 107         if ($cm) {
 108             $this->cm = $cm;
 109         } else {
 110             $this->cm = get_coursemodule_from_instance('data', $this->data->id);
 111         }
 112
 113         if (empty($this->field)) {         // We need to define some default values
 114             $this->define_default_field();
 115         }
 116
 117         $this->context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
 118     }
 119
 120
 121     /**
 122      * This field just sets up a default field object
 123      *
 124      * @return bool
 125      */
 126     function define_default_field() {
 127         global $OUTPUT;
 128         if (empty($this->data->id)) {
 129             echo $OUTPUT->notification('Programmer error: dataid not defined in field class');
 130         }
 131         $this->field = new stdClass();
 132         $this->field->id = 0;
 133         $this->field->dataid = $this->data->id;
 134         $this->field->type   = $this->type;
 135         $this->field->param1 = '';
 136         $this->field->param2 = '';
 137         $this->field->param3 = '';
 138         $this->field->name = '';
 139         $this->field->description = '';
 140
 141         return true;
 142     }
 143
 144     /**
 145      * Set up the field object according to data in an object.  Now is the time to clean it!
 146      *
 147      * @return bool
 148      */
 149     function define_field($data) {
 150         $this->field->type        = $this->type;
 151         $this->field->dataid      = $this->data->id;
 152
 153         $this->field->name        = trim($data->name);
 154         $this->field->description = trim($data->description);
 155
 156         if (isset($data->param1)) {
 157             $this->field->param1 = trim($data->param1);
 158         }
 159         if (isset($data->param2)) {
 160             $this->field->param2 = trim($data->param2);
 161         }
 162         if (isset($data->param3)) {
 163             $this->field->param3 = trim($data->param3);
 164         }
 165         if (isset($data->param4)) {
 166             $this->field->param4 = trim($data->param4);
 167         }
 168         if (isset($data->param5)) {
 169             $this->field->param5 = trim($data->param5);
 170         }
 171
 172         return true;
 173     }
 174
 175     /**
 176      * Insert a new field in the database
 177      * We assume the field object is already defined as $this->field
 178      *
 179      * @global object
 180      * @return bool
 181      */
 182     function insert_field() {
 183         global $DB, $OUTPUT;
 184
 185         if (empty($this->field)) {
 186             echo $OUTPUT->notification('Programmer error: Field has not been defined yet!  See define_field()');
 187             return false;
 188         }
 189
 190         $this->field->id = $DB->insert_record('data_fields',$this->field);
 191         return true;
 192     }
 193
 194
 195     /**
 196      * Update a field in the database
 197      *
 198      * @global object
 199      * @return bool
 200      */
 201     function update_field() {
 202         global $DB;
 203
 204         $DB->update_record('data_fields', $this->field);
 205         return true;
 206     }
 207
 208     /**
 209      * Delete a field completely
 210      *
 211      * @global object
 212      * @return bool
 213      */
 214     function delete_field() {
 215         global $DB;
 216
 217         if (!empty($this->field->id)) {
 218             $this->delete_content();
 219             $DB->delete_records('data_fields', array('id'=>$this->field->id));
 220         }
 221         return true;
 222     }
 223
 224     /**
 225      * Print the relevant form element in the ADD template for this field
 226      *
 227      * @global object
 228      * @param int $recordid
 229      * @return string
 230      */
 231     function display_add_field($recordid=0){
 232         global $DB;
 233
 234         if ($recordid){
 235             $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
 236         } else {
 237             $content = '';
 238         }
 239
 240         // beware get_field returns false for new, empty records MDL-18567
 241         if ($content===false) {
 242             $content='';
 243         }
 244
 245         $str = '<div title="'.s($this->field->description).'">';
 246         $str .= '<input style="width:300px;" type="text" name="field_'.$this->field->id.'" id="field_'.$this->field->id.'" value="'.s($content).'" />';
 247         $str .= '</div>';
 248
 249         return $str;
 250     }
 251
 252     /**
 253      * Print the relevant form element to define the attributes for this field
 254      * viewable by teachers only.
 255      *
 256      * @global object
 257      * @global object
 258      * @return void Output is echo'd
 259      */
 260     function display_edit_field() {
 261         global $CFG, $DB, $OUTPUT;
 262
 263         if (empty($this->field)) {   // No field has been defined yet, try and make one
 264             $this->define_default_field();
 265         }
 266         echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthwide');
 267
 268         echo '<form id="editfield" action="'.$CFG->wwwroot.'/mod/data/field.php" method="post">'."\n";
 269         echo '<input type="hidden" name="d" value="'.$this->data->id.'" />'."\n";
 270         if (empty($this->field->id)) {
 271             echo '<input type="hidden" name="mode" value="add" />'."\n";
 272             $savebutton = get_string('add');
 273         } else {
 274             echo '<input type="hidden" name="fid" value="'.$this->field->id.'" />'."\n";
 275             echo '<input type="hidden" name="mode" value="update" />'."\n";
 276             $savebutton = get_string('savechanges');
 277         }
 278         echo '<input type="hidden" name="type" value="'.$this->type.'" />'."\n";
 279         echo '<input name="sesskey" value="'.sesskey().'" type="hidden" />'."\n";
 280
 281         echo $OUTPUT->heading($this->name());
 282
 283         require_once($CFG->dirroot.'/mod/data/field/'.$this->type.'/mod.html');
 284
 285         echo '<div class="mdl-align">';
 286         echo '<input type="submit" value="'.$savebutton.'" />'."\n";
 287         echo '<input type="submit" name="cancel" value="'.get_string('cancel').'" />'."\n";
 288         echo '</div>';
 289
 290         echo '</form>';
 291
 292         echo $OUTPUT->box_end();
 293     }
 294
 295     /**
 296      * Display the content of the field in browse mode
 297      *
 298      * @global object
 299      * @param int $recordid
 300      * @param object $template
 301      * @return bool|string
 302      */
 303     function display_browse_field($recordid, $template) {
 304         global $DB;
 305
 306         if ($content = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
 307             if (isset($content->content)) {
 308                 $options = new stdClass();
 309                 if ($this->field->param1 == '1') {  // We are autolinking this field, so disable linking within us
 310                     //$content->content = '<span class="nolink">'.$content->content.'</span>';
 311                     //$content->content1 = FORMAT_HTML;
 312                     $options->filter=false;
 313                 }
 314                 $options->para = false;
 315                 $str = format_text($content->content, $content->content1, $options);
 316             } else {
 317                 $str = '';
 318             }
 319             return $str;
 320         }
 321         return false;
 322     }
 323
 324     /**
 325      * Update the content of one data field in the data_content table
 326      * @global object
 327      * @param int $recordid
 328      * @param mixed $value
 329      * @param string $name
 330      * @return bool
 331      */
 332     function update_content($recordid, $value, $name=''){
 333         global $DB;
 334
 335         $content = new stdClass();
 336         $content->fieldid = $this->field->id;
 337         $content->recordid = $recordid;
 338         $content->content = clean_param($value, PARAM_NOTAGS);
 339
 340         if ($oldcontent = $DB->get_record('data_content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid))) {
 341             $content->id = $oldcontent->id;
 342             return $DB->update_record('data_content', $content);
 343         } else {
 344             return $DB->insert_record('data_content', $content);
 345         }
 346     }
 347
 348     /**
 349      * Delete all content associated with the field
 350      *
 351      * @global object
 352      * @param int $recordid
 353      * @return bool
 354      */
 355     function delete_content($recordid=0) {
 356         global $DB;
 357
 358         if ($recordid) {
 359             $conditions = array('fieldid'=>$this->field->id, 'recordid'=>$recordid);
 360         } else {
 361             $conditions = array('fieldid'=>$this->field->id);
 362         }
 363
 364         $rs = $DB->get_recordset('data_content', $conditions);
 365         if ($rs->valid()) {
 366             $fs = get_file_storage();
 367             foreach ($rs as $content) {
 368                 $fs->delete_area_files($this->context->id, 'mod_data', 'content', $content->id);
 369             }
 370         }
 371         $rs->close();
 372
 373         return $DB->delete_records('data_content', $conditions);
 374     }
 375
 376     /**
 377      * Check if a field from an add form is empty
 378      *
 379      * @param mixed $value
 380      * @param mixed $name
 381      * @return bool
 382      */
 383     function notemptyfield($value, $name) {
 384         return !empty($value);
 385     }
 386
 387     /**
 388      * Just in case a field needs to print something before the whole form
 389      */
 390     function print_before_form() {
 391     }
 392
 393     /**
 394      * Just in case a field needs to print something after the whole form
 395      */
 396     function print_after_form() {
 397     }
 398
 399
 400     /**
 401      * Returns the sortable field for the content. By default, it's just content
 402      * but for some plugins, it could be content 1 - content4
 403      *
 404      * @return string
 405      */
 406     function get_sort_field() {
 407         return 'content';
 408     }
 409
 410     /**
 411      * Returns the SQL needed to refer to the column.  Some fields may need to CAST() etc.
 412      *
 413      * @param string $fieldname
 414      * @return string $fieldname
 415      */
 416     function get_sort_sql($fieldname) {
 417         return $fieldname;
 418     }
 419
 420     /**
 421      * Returns the name/type of the field
 422      *
 423      * @return string
 424      */
 425     function name() {
 426         return get_string('name'.$this->type, 'data');
 427     }
 428
 429     /**
 430      * Prints the respective type icon
 431      *
 432      * @global object
 433      * @return string
 434      */
 435     function image() {
 436         global $OUTPUT;
 437
 438         $params = array('d'=>$this->data->id, 'fid'=>$this->field->id, 'mode'=>'display', 'sesskey'=>sesskey());
 439         $link = new moodle_url('/mod/data/field.php', $params);
 440         $str = '<a href="'.$link->out().'">';
 441         $str .= '<img src="'.$OUTPUT->pix_url('field/'.$this->type, 'data') . '" ';
 442         $str .= 'height="'.$this->iconheight.'" width="'.$this->iconwidth.'" alt="'.$this->type.'" title="'.$this->type.'" /></a>';
 443         return $str;
 444     }
 445
 446     /**
 447      * Per default, it is assumed that fields support text exporting.
 448      * Override this (return false) on fields not supporting text exporting.
 449      *
 450      * @return bool true
 451      */
 452     function text_export_supported() {
 453         return true;
 454     }
 455
 456     /**
 457      * Per default, return the record's text value only from the "content" field.
 458      * Override this in fields class if necesarry.
 459      *
 460      * @param string $record
 461      * @return string
 462      */
 463     function export_text_value($record) {
 464         if ($this->text_export_supported()) {
 465             return $record->content;
 466         }
 467     }
 468
 469     /**
 470      * @param string $relativepath
 471      * @return bool false
 472      */
 473     function file_ok($relativepath) {
 474         return false;
 475     }
 476 }
 477
 478
 479 /**
 480  * Given a template and a dataid, generate a default case template
 481  *
 482  * @global object
 483  * @param object $data
 484  * @param string template [addtemplate, singletemplate, listtempalte, rsstemplate]
 485  * @param int $recordid
 486  * @param bool $form
 487  * @param bool $update
 488  * @return bool|string
 489  */
 490 function data_generate_default_template(&$data, $template, $recordid=0, $form=false, $update=true) {
 491     global $DB;
 492
 493     if (!$data && !$template) {
 494         return false;
 495     }
 496     if ($template == 'csstemplate' or $template == 'jstemplate' ) {
 497         return '';
 498     }
 499
 500     // get all the fields for that database
 501     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'id')) {
 502
 503         $table = new html_table();
 504         $table->attributes['class'] = 'mod-data-default-template';
 505         $table->colclasses = array('template-field', 'template-token');
 506         $table->data = array();
 507         foreach ($fields as $field) {
 508             if ($form) {   // Print forms instead of data
 509                 $fieldobj = data_get_field($field, $data);
 510                 $token = $fieldobj->display_add_field($recordid);
 511             } else {           // Just print the tag
 512                 $token = '[['.$field->name.']]';
 513             }
 514             $table->data[] = array(
 515                 $field->name.': ',
 516                 $token
 517             );
 518         }
 519         if ($template == 'listtemplate') {
 520             $cell = new html_table_cell('##edit##  ##more##  ##delete##  ##approve##  ##export##');
 521             $cell->colspan = 2;
 522             $cell->attributes['class'] = 'controls';
 523             $table->data[] = new html_table_row(array($cell));
 524         } else if ($template == 'singletemplate') {
 525             $cell = new html_table_cell('##edit##  ##delete##  ##approve##  ##export##');
 526             $cell->colspan = 2;
 527             $cell->attributes['class'] = 'controls';
 528             $table->data[] = new html_table_row(array($cell));
 529         } else if ($template == 'asearchtemplate') {
 530             $row = new html_table_row(array(get_string('authorfirstname', 'data').': ', '##firstname##'));
 531             $row->attributes['class'] = 'searchcontrols';
 532             $table->data[] = $row;
 533             $row = new html_table_row(array(get_string('authorlastname', 'data').': ', '##lastname##'));
 534             $row->attributes['class'] = 'searchcontrols';
 535             $table->data[] = $row;
 536         }
 537
 538         $str  = html_writer::start_tag('div', array('class' => 'defaulttemplate'));
 539         $str .= html_writer::table($table);
 540         $str .= html_writer::end_tag('div');
 541         if ($template == 'listtemplate'){
 542             $str .= html_writer::empty_tag('hr');
 543         }
 544
 545         if ($update) {
 546             $newdata = new stdClass();
 547             $newdata->id = $data->id;
 548             $newdata->{$template} = $str;
 549             $DB->update_record('data', $newdata);
 550             $data->{$template} = $str;
 551         }
 552
 553         return $str;
 554     }
 555 }
 556
 557
 558 /**
 559  * Search for a field name and replaces it with another one in all the
 560  * form templates. Set $newfieldname as '' if you want to delete the
 561  * field from the form.
 562  *
 563  * @global object
 564  * @param object $data
 565  * @param string $searchfieldname
 566  * @param string $newfieldname
 567  * @return bool
 568  */
 569 function data_replace_field_in_templates($data, $searchfieldname, $newfieldname) {
 570     global $DB;
 571
 572     if (!empty($newfieldname)) {
 573         $prestring = '[[';
 574         $poststring = ']]';
 575         $idpart = '#id';
 576
 577     } else {
 578         $prestring = '';
 579         $poststring = '';
 580         $idpart = '';
 581     }
 582
 583     $newdata = new stdClass();
 584     $newdata->id = $data->id;
 585     $newdata->singletemplate = str_ireplace('[['.$searchfieldname.']]',
 586             $prestring.$newfieldname.$poststring, $data->singletemplate);
 587
 588     $newdata->listtemplate = str_ireplace('[['.$searchfieldname.']]',
 589             $prestring.$newfieldname.$poststring, $data->listtemplate);
 590
 591     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.']]',
 592             $prestring.$newfieldname.$poststring, $data->addtemplate);
 593
 594     $newdata->addtemplate = str_ireplace('[['.$searchfieldname.'#id]]',
 595             $prestring.$newfieldname.$idpart.$poststring, $data->addtemplate);
 596
 597     $newdata->rsstemplate = str_ireplace('[['.$searchfieldname.']]',
 598             $prestring.$newfieldname.$poststring, $data->rsstemplate);
 599
 600     return $DB->update_record('data', $newdata);
 601 }
 602
 603
 604 /**
 605  * Appends a new field at the end of the form template.
 606  *
 607  * @global object
 608  * @param object $data
 609  * @param string $newfieldname
 610  */
 611 function data_append_new_field_to_templates($data, $newfieldname) {
 612     global $DB;
 613
 614     $newdata = new stdClass();
 615     $newdata->id = $data->id;
 616     $change = false;
 617
 618     if (!empty($data->singletemplate)) {
 619         $newdata->singletemplate = $data->singletemplate.' [[' . $newfieldname .']]';
 620         $change = true;
 621     }
 622     if (!empty($data->addtemplate)) {
 623         $newdata->addtemplate = $data->addtemplate.' [[' . $newfieldname . ']]';
 624         $change = true;
 625     }
 626     if (!empty($data->rsstemplate)) {
 627         $newdata->rsstemplate = $data->singletemplate.' [[' . $newfieldname . ']]';
 628         $change = true;
 629     }
 630     if ($change) {
 631         $DB->update_record('data', $newdata);
 632     }
 633 }
 634
 635
 636 /**
 637  * given a field name
 638  * this function creates an instance of the particular subfield class
 639  *
 640  * @global object
 641  * @param string $name
 642  * @param object $data
 643  * @return object|bool
 644  */
 645 function data_get_field_from_name($name, $data){
 646     global $DB;
 647
 648     $field = $DB->get_record('data_fields', array('name'=>$name, 'dataid'=>$data->id));
 649
 650     if ($field) {
 651         return data_get_field($field, $data);
 652     } else {
 653         return false;
 654     }
 655 }
 656
 657 /**
 658  * given a field id
 659  * this function creates an instance of the particular subfield class
 660  *
 661  * @global object
 662  * @param int $fieldid
 663  * @param object $data
 664  * @return bool|object
 665  */
 666 function data_get_field_from_id($fieldid, $data){
 667     global $DB;
 668
 669     $field = $DB->get_record('data_fields', array('id'=>$fieldid, 'dataid'=>$data->id));
 670
 671     if ($field) {
 672         return data_get_field($field, $data);
 673     } else {
 674         return false;
 675     }
 676 }
 677
 678 /**
 679  * given a field id
 680  * this function creates an instance of the particular subfield class
 681  *
 682  * @global object
 683  * @param string $type
 684  * @param object $data
 685  * @return object
 686  */
 687 function data_get_field_new($type, $data) {
 688     global $CFG;
 689
 690     require_once($CFG->dirroot.'/mod/data/field/'.$type.'/field.class.php');
 691     $newfield = 'data_field_'.$type;
 692     $newfield = new $newfield(0, $data);
 693     return $newfield;
 694 }
 695
 696 /**
 697  * returns a subclass field object given a record of the field, used to
 698  * invoke plugin methods
 699  * input: $param $field - record from db
 700  *
 701  * @global object
 702  * @param object $field
 703  * @param object $data
 704  * @param object $cm
 705  * @return object
 706  */
 707 function data_get_field($field, $data, $cm=null) {
 708     global $CFG;
 709
 710     if ($field) {
 711         require_once('field/'.$field->type.'/field.class.php');
 712         $newfield = 'data_field_'.$field->type;
 713         $newfield = new $newfield($field, $data, $cm);
 714         return $newfield;
 715     }
 716 }
 717
 718
 719 /**
 720  * Given record object (or id), returns true if the record belongs to the current user
 721  *
 722  * @global object
 723  * @global object
 724  * @param mixed $record record object or id
 725  * @return bool
 726  */
 727 function data_isowner($record) {
 728     global $USER, $DB;
 729
 730     if (!isloggedin()) { // perf shortcut
 731         return false;
 732     }
 733
 734     if (!is_object($record)) {
 735         if (!$record = $DB->get_record('data_records', array('id'=>$record))) {
 736             return false;
 737         }
 738     }
 739
 740     return ($record->userid == $USER->id);
 741 }
 742
 743 /**
 744  * has a user reached the max number of entries?
 745  *
 746  * @param object $data
 747  * @return bool
 748  */
 749 function data_atmaxentries($data){
 750     if (!$data->maxentries){
 751         return false;
 752
 753     } else {
 754         return (data_numentries($data) >= $data->maxentries);
 755     }
 756 }
 757
 758 /**
 759  * returns the number of entries already made by this user
 760  *
 761  * @global object
 762  * @global object
 763  * @param object $data
 764  * @return int
 765  */
 766 function data_numentries($data){
 767     global $USER, $DB;
 768     $sql = 'SELECT COUNT(*) FROM {data_records} WHERE dataid=? AND userid=?';
 769     return $DB->count_records_sql($sql, array($data->id, $USER->id));
 770 }
 771
 772 /**
 773  * function that takes in a dataid and adds a record
 774  * this is used everytime an add template is submitted
 775  *
 776  * @global object
 777  * @global object
 778  * @param object $data
 779  * @param int $groupid
 780  * @return bool
 781  */
 782 function data_add_record($data, $groupid=0){
 783     global $USER, $DB;
 784
 785     $cm = get_coursemodule_from_instance('data', $data->id);
 786     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 787
 788     $record = new stdClass();
 789     $record->userid = $USER->id;
 790     $record->dataid = $data->id;
 791     $record->groupid = $groupid;
 792     $record->timecreated = $record->timemodified = time();
 793     if (has_capability('mod/data:approve', $context)) {
 794         $record->approved = 1;
 795     } else {
 796         $record->approved = 0;
 797     }
 798     return $DB->insert_record('data_records', $record);
 799 }
 800
 801 /**
 802  * check the multple existence any tag in a template
 803  *
 804  * check to see if there are 2 or more of the same tag being used.
 805  *
 806  * @global object
 807  * @param int $dataid,
 808  * @param string $template
 809  * @return bool
 810  */
 811 function data_tags_check($dataid, $template) {
 812     global $DB, $OUTPUT;
 813
 814     // first get all the possible tags
 815     $fields = $DB->get_records('data_fields', array('dataid'=>$dataid));
 816     // then we generate strings to replace
 817     $tagsok = true; // let's be optimistic
 818     foreach ($fields as $field){
 819         $pattern="/\[\[".$field->name."\]\]/i";
 820         if (preg_match_all($pattern, $template, $dummy)>1){
 821             $tagsok = false;
 822             echo $OUTPUT->notification('[['.$field->name.']] - '.get_string('multipletags','data'));
 823         }
 824     }
 825     // else return true
 826     return $tagsok;
 827 }
 828
 829 /**
 830  * Adds an instance of a data
 831  *
 832  * @global object
 833  * @param object $data
 834  * @return $int
 835  */
 836 function data_add_instance($data) {
 837     global $DB;
 838
 839     if (empty($data->assessed)) {
 840         $data->assessed = 0;
 841     }
 842
 843     $data->timemodified = time();
 844
 845     $data->id = $DB->insert_record('data', $data);
 846
 847     data_grade_item_update($data);
 848
 849     return $data->id;
 850 }
 851
 852 /**
 853  * updates an instance of a data
 854  *
 855  * @global object
 856  * @param object $data
 857  * @return bool
 858  */
 859 function data_update_instance($data) {
 860     global $DB, $OUTPUT;
 861
 862     $data->timemodified = time();
 863     $data->id           = $data->instance;
 864
 865     if (empty($data->assessed)) {
 866         $data->assessed = 0;
 867     }
 868
 869     if (empty($data->ratingtime) or empty($data->assessed)) {
 870         $data->assesstimestart  = 0;
 871         $data->assesstimefinish = 0;
 872     }
 873
 874     if (empty($data->notification)) {
 875         $data->notification = 0;
 876     }
 877
 878     $DB->update_record('data', $data);
 879
 880     data_grade_item_update($data);
 881
 882     return true;
 883
 884 }
 885
 886 /**
 887  * deletes an instance of a data
 888  *
 889  * @global object
 890  * @param int $id
 891  * @return bool
 892  */
 893 function data_delete_instance($id) {    // takes the dataid
 894     global $DB, $CFG;
 895
 896     if (!$data = $DB->get_record('data', array('id'=>$id))) {
 897         return false;
 898     }
 899
 900     $cm = get_coursemodule_from_instance('data', $data->id);
 901     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 902
 903 /// Delete all the associated information
 904
 905     // files
 906     $fs = get_file_storage();
 907     $fs->delete_area_files($context->id, 'mod_data');
 908
 909     // get all the records in this data
 910     $sql = "SELECT r.id
 911               FROM {data_records} r
 912              WHERE r.dataid = ?";
 913
 914     $DB->delete_records_select('data_content', "recordid IN ($sql)", array($id));
 915
 916     // delete all the records and fields
 917     $DB->delete_records('data_records', array('dataid'=>$id));
 918     $DB->delete_records('data_fields', array('dataid'=>$id));
 919
 920     // Delete the instance itself
 921     $result = $DB->delete_records('data', array('id'=>$id));
 922
 923     // cleanup gradebook
 924     data_grade_item_delete($data);
 925
 926     return $result;
 927 }
 928
 929 /**
 930  * returns a summary of data activity of this user
 931  *
 932  * @global object
 933  * @param object $course
 934  * @param object $user
 935  * @param object $mod
 936  * @param object $data
 937  * @return object|null
 938  */
 939 function data_user_outline($course, $user, $mod, $data) {
 940     global $DB, $CFG;
 941     require_once("$CFG->libdir/gradelib.php");
 942
 943     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
 944     if (empty($grades->items[0]->grades)) {
 945         $grade = false;
 946     } else {
 947         $grade = reset($grades->items[0]->grades);
 948     }
 949
 950
 951     if ($countrecords = $DB->count_records('data_records', array('dataid'=>$data->id, 'userid'=>$user->id))) {
 952         $result = new stdClass();
 953         $result->info = get_string('numrecords', 'data', $countrecords);
 954         $lastrecord   = $DB->get_record_sql('SELECT id,timemodified FROM {data_records}
 955                                               WHERE dataid = ? AND userid = ?
 956                                            ORDER BY timemodified DESC', array($data->id, $user->id), true);
 957         $result->time = $lastrecord->timemodified;
 958         if ($grade) {
 959             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
 960         }
 961         return $result;
 962     } else if ($grade) {
 963         $result = new stdClass();
 964         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
 965
 966         //datesubmitted == time created. dategraded == time modified or time overridden
 967         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
 968         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
 969         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
 970             $result->time = $grade->dategraded;
 971         } else {
 972             $result->time = $grade->datesubmitted;
 973         }
 974
 975         return $result;
 976     }
 977     return NULL;
 978 }
 979
 980 /**
 981  * Prints all the records uploaded by this user
 982  *
 983  * @global object
 984  * @param object $course
 985  * @param object $user
 986  * @param object $mod
 987  * @param object $data
 988  */
 989 function data_user_complete($course, $user, $mod, $data) {
 990     global $DB, $CFG, $OUTPUT;
 991     require_once("$CFG->libdir/gradelib.php");
 992
 993     $grades = grade_get_grades($course->id, 'mod', 'data', $data->id, $user->id);
 994     if (!empty($grades->items[0]->grades)) {
 995         $grade = reset($grades->items[0]->grades);
 996         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
 997         if ($grade->str_feedback) {
 998             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
 999         }
1000     }
1001
1002     if ($records = $DB->get_records('data_records', array('dataid'=>$data->id,'userid'=>$user->id), 'timemodified DESC')) {
1003         data_print_template('singletemplate', $records, $data);
1004     }
1005 }
1006
1007 /**
1008  * Return grade for given user or all users.
1009  *
1010  * @global object
1011  * @param object $data
1012  * @param int $userid optional user id, 0 means all users
1013  * @return array array of grades, false if none
1014  */
1015 function data_get_user_grades($data, $userid=0) {
1016     global $CFG;
1017
1018     require_once($CFG->dirroot.'/rating/lib.php');
1019
1020     $ratingoptions = new stdClass;
1021     $ratingoptions->component = 'mod_data';
1022     $ratingoptions->ratingarea = 'entry';
1023     $ratingoptions->modulename = 'data';
1024     $ratingoptions->moduleid   = $data->id;
1025
1026     $ratingoptions->userid = $userid;
1027     $ratingoptions->aggregationmethod = $data->assessed;
1028     $ratingoptions->scaleid = $data->scale;
1029     $ratingoptions->itemtable = 'data_records';
1030     $ratingoptions->itemtableusercolumn = 'userid';
1031
1032     $rm = new rating_manager();
1033     return $rm->get_user_grades($ratingoptions);
1034 }
1035
1036 /**
1037  * Update activity grades
1038  *
1039  * @global object
1040  * @global object
1041  * @param object $data
1042  * @param int $userid specific user only, 0 means all
1043  * @param bool $nullifnone
1044  */
1045 function data_update_grades($data, $userid=0, $nullifnone=true) {
1046     global $CFG, $DB;
1047     require_once($CFG->libdir.'/gradelib.php');
1048
1049     if (!$data->assessed) {
1050         data_grade_item_update($data);
1051
1052     } else if ($grades = data_get_user_grades($data, $userid)) {
1053         data_grade_item_update($data, $grades);
1054
1055     } else if ($userid and $nullifnone) {
1056         $grade = new stdClass();
1057         $grade->userid   = $userid;
1058         $grade->rawgrade = NULL;
1059         data_grade_item_update($data, $grade);
1060
1061     } else {
1062         data_grade_item_update($data);
1063     }
1064 }
1065
1066 /**
1067  * Update all grades in gradebook.
1068  *
1069  * @global object
1070  */
1071 function data_upgrade_grades() {
1072     global $DB;
1073
1074     $sql = "SELECT COUNT('x')
1075               FROM {data} d, {course_modules} cm, {modules} m
1076              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1077     $count = $DB->count_records_sql($sql);
1078
1079     $sql = "SELECT d.*, cm.idnumber AS cmidnumber, d.course AS courseid
1080               FROM {data} d, {course_modules} cm, {modules} m
1081              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id";
1082     $rs = $DB->get_recordset_sql($sql);
1083     if ($rs->valid()) {
1084         // too much debug output
1085         $pbar = new progress_bar('dataupgradegrades', 500, true);
1086         $i=0;
1087         foreach ($rs as $data) {
1088             $i++;
1089             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
1090             data_update_grades($data, 0, false);
1091             $pbar->update($i, $count, "Updating Database grades ($i/$count).");
1092         }
1093     }
1094     $rs->close();
1095 }
1096
1097 /**
1098  * Update/create grade item for given data
1099  *
1100  * @global object
1101  * @param object $data object with extra cmidnumber
1102  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
1103  * @return object grade_item
1104  */
1105 function data_grade_item_update($data, $grades=NULL) {
1106     global $CFG;
1107     require_once($CFG->libdir.'/gradelib.php');
1108
1109     $params = array('itemname'=>$data->name, 'idnumber'=>$data->cmidnumber);
1110
1111     if (!$data->assessed or $data->scale == 0) {
1112         $params['gradetype'] = GRADE_TYPE_NONE;
1113
1114     } else if ($data->scale > 0) {
1115         $params['gradetype'] = GRADE_TYPE_VALUE;
1116         $params['grademax']  = $data->scale;
1117         $params['grademin']  = 0;
1118
1119     } else if ($data->scale < 0) {
1120         $params['gradetype'] = GRADE_TYPE_SCALE;
1121         $params['scaleid']   = -$data->scale;
1122     }
1123
1124     if ($grades  === 'reset') {
1125         $params['reset'] = true;
1126         $grades = NULL;
1127     }
1128
1129     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, $grades, $params);
1130 }
1131
1132 /**
1133  * Delete grade item for given data
1134  *
1135  * @global object
1136  * @param object $data object
1137  * @return object grade_item
1138  */
1139 function data_grade_item_delete($data) {
1140     global $CFG;
1141     require_once($CFG->libdir.'/gradelib.php');
1142
1143     return grade_update('mod/data', $data->course, 'mod', 'data', $data->id, 0, NULL, array('deleted'=>1));
1144 }
1145
1146 /**
1147  * returns a list of participants of this database
1148  *
1149  * Returns the users with data in one data
1150  * (users with records in data_records, data_comments and ratings)
1151  *
1152  * @todo: deprecated - to be deleted in 2.2
1153  *
1154  * @param int $dataid
1155  * @return array
1156  */
1157 function data_get_participants($dataid) {
1158     global $DB;
1159
1160     $params = array('dataid' => $dataid);
1161
1162     $sql = "SELECT DISTINCT u.id, u.id
1163               FROM {user} u,
1164                    {data_records} r
1165              WHERE r.dataid = :dataid AND
1166                    u.id = r.userid";
1167     $records = $DB->get_records_sql($sql, $params);
1168
1169     $sql = "SELECT DISTINCT u.id, u.id
1170               FROM {user} u,
1171                    {data_records} r,
1172                    {comments} c
1173              WHERE r.dataid = ? AND
1174                    u.id = r.userid AND
1175                    r.id = c.itemid AND
1176                    c.commentarea = 'database_entry'";
1177     $comments = $DB->get_records_sql($sql, $params);
1178
1179     $sql = "SELECT DISTINCT u.id, u.id
1180               FROM {user} u,
1181                    {data_records} r,
1182                    {ratings} a
1183              WHERE r.dataid = ? AND
1184                    u.id = r.userid AND
1185                    r.id = a.itemid AND
1186                    a.component = 'mod_data' AND
1187                    a.ratingarea = 'entry'";
1188     $ratings = $DB->get_records_sql($sql, $params);
1189
1190     $participants = array();
1191
1192     if ($records) {
1193         foreach ($records as $record) {
1194             $participants[$record->id] = $record;
1195         }
1196     }
1197     if ($comments) {
1198         foreach ($comments as $comment) {
1199             $participants[$comment->id] = $comment;
1200         }
1201     }
1202     if ($ratings) {
1203         foreach ($ratings as $rating) {
1204             $participants[$rating->id] = $rating;
1205         }
1206     }
1207
1208     return $participants;
1209 }
1210
1211 // junk functions
1212 /**
1213  * takes a list of records, the current data, a search string,
1214  * and mode to display prints the translated template
1215  *
1216  * @global object
1217  * @global object
1218  * @param string $template
1219  * @param array $records
1220  * @param object $data
1221  * @param string $search
1222  * @param int $page
1223  * @param bool $return
1224  * @return mixed
1225  */
1226 function data_print_template($template, $records, $data, $search='', $page=0, $return=false) {
1227     global $CFG, $DB, $OUTPUT;
1228     $cm = get_coursemodule_from_instance('data', $data->id);
1229     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1230
1231     static $fields = NULL;
1232     static $isteacher;
1233     static $dataid = NULL;
1234
1235     if (empty($dataid)) {
1236         $dataid = $data->id;
1237     } else if ($dataid != $data->id) {
1238         $fields = NULL;
1239     }
1240
1241     if (empty($fields)) {
1242         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1243         foreach ($fieldrecords as $fieldrecord) {
1244             $fields[]= data_get_field($fieldrecord, $data);
1245         }
1246         $isteacher = has_capability('mod/data:managetemplates', $context);
1247     }
1248
1249     if (empty($records)) {
1250         return;
1251     }
1252
1253     foreach ($records as $record) {   // Might be just one for the single template
1254
1255     // Replacing tags
1256         $patterns = array();
1257         $replacement = array();
1258
1259     // Then we generate strings to replace for normal tags
1260         foreach ($fields as $field) {
1261             $patterns[]='[['.$field->field->name.']]';
1262             $replacement[] = highlight($search, $field->display_browse_field($record->id, $template));
1263         }
1264
1265     // Replacing special tags (##Edit##, ##Delete##, ##More##)
1266         $patterns[]='##edit##';
1267         $patterns[]='##delete##';
1268         if (has_capability('mod/data:manageentries', $context) or data_isowner($record->id)) {
1269             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/edit.php?d='
1270                              .$data->id.'&amp;rid='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" alt="'.get_string('edit').'" title="'.get_string('edit').'" /></a>';
1271             $replacement[] = '<a href="'.$CFG->wwwroot.'/mod/data/view.php?d='
1272                              .$data->id.'&amp;delete='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('t/delete') . '" class="iconsmall" alt="'.get_string('delete').'" title="'.get_string('delete').'" /></a>';
1273         } else {
1274             $replacement[] = '';
1275             $replacement[] = '';
1276         }
1277
1278         $moreurl = $CFG->wwwroot . '/mod/data/view.php?d=' . $data->id . '&amp;rid=' . $record->id;
1279         if ($search) {
1280             $moreurl .= '&amp;filter=1';
1281         }
1282         $patterns[]='##more##';
1283         $replacement[] = '<a href="' . $moreurl . '"><img src="' . $OUTPUT->pix_url('i/search') . '" class="iconsmall" alt="' . get_string('more', 'data') . '" title="' . get_string('more', 'data') . '" /></a>';
1284
1285         $patterns[]='##moreurl##';
1286         $replacement[] = $moreurl;
1287
1288         $patterns[]='##user##';
1289         $replacement[] = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$record->userid.
1290                                '&amp;course='.$data->course.'">'.fullname($record).'</a>';
1291
1292         $patterns[]='##export##';
1293
1294         if (!empty($CFG->enableportfolios) && ($template == 'singletemplate' || $template == 'listtemplate')
1295             && ((has_capability('mod/data:exportentry', $context)
1296                 || (data_isowner($record->id) && has_capability('mod/data:exportownentry', $context))))) {
1297             require_once($CFG->libdir . '/portfoliolib.php');
1298             $button = new portfolio_add_button();
1299             $button->set_callback_options('data_portfolio_caller', array('id' => $cm->id, 'recordid' => $record->id), '/mod/data/locallib.php');
1300             list($formats, $files) = data_portfolio_caller::formats($fields, $record);
1301             $button->set_formats($formats);
1302             $replacement[] = $button->to_html(PORTFOLIO_ADD_ICON_LINK);
1303         } else {
1304             $replacement[] = '';
1305         }
1306
1307         $patterns[] = '##timeadded##';
1308         $replacement[] = userdate($record->timecreated);
1309
1310         $patterns[] = '##timemodified##';
1311         $replacement [] = userdate($record->timemodified);
1312
1313         $patterns[]='##approve##';
1314         if (has_capability('mod/data:approve', $context) && ($data->approval) && (!$record->approved)){
1315             $replacement[] = '<span class="approve"><a href="'.$CFG->wwwroot.'/mod/data/view.php?d='.$data->id.'&amp;approve='.$record->id.'&amp;sesskey='.sesskey().'"><img src="'.$OUTPUT->pix_url('i/approve') . '" class="icon" alt="'.get_string('approve').'" /></a></span>';
1316         } else {
1317             $replacement[] = '';
1318         }
1319
1320         $patterns[]='##comments##';
1321         if (($template == 'listtemplate') && ($data->comments)) {
1322
1323             if (!empty($CFG->usecomments)) {
1324                 require_once($CFG->dirroot  . '/comment/lib.php');
1325                 list($context, $course, $cm) = get_context_info_array($context->id);
1326                 $cmt = new stdClass();
1327                 $cmt->context = $context;
1328                 $cmt->course  = $course;
1329                 $cmt->cm      = $cm;
1330                 $cmt->area    = 'database_entry';
1331                 $cmt->itemid  = $record->id;
1332                 $cmt->showcount = true;
1333                 $cmt->component = 'mod_data';
1334                 $comment = new comment($cmt);
1335                 $replacement[] = $comment->output(true);
1336             }
1337         } else {
1338             $replacement[] = '';
1339         }
1340
1341         // actual replacement of the tags
1342         $newtext = str_ireplace($patterns, $replacement, $data->{$template});
1343
1344         // no more html formatting and filtering - see MDL-6635
1345         if ($return) {
1346             return $newtext;
1347         } else {
1348             echo $newtext;
1349
1350             // hack alert - return is always false in singletemplate anyway ;-)
1351             /**********************************
1352              *    Printing Ratings Form       *
1353              *********************************/
1354             if ($template == 'singletemplate') {    //prints ratings options
1355                 data_print_ratings($data, $record);
1356             }
1357
1358             /**********************************
1359              *    Printing Comments Form       *
1360              *********************************/
1361             if (($template == 'singletemplate') && ($data->comments)) {
1362                 if (!empty($CFG->usecomments)) {
1363                     require_once($CFG->dirroot . '/comment/lib.php');
1364                     list($context, $course, $cm) = get_context_info_array($context->id);
1365                     $cmt = new stdClass();
1366                     $cmt->context = $context;
1367                     $cmt->course  = $course;
1368                     $cmt->cm      = $cm;
1369                     $cmt->area    = 'database_entry';
1370                     $cmt->itemid  = $record->id;
1371                     $cmt->showcount = true;
1372                     $cmt->component = 'mod_data';
1373                     $comment = new comment($cmt);
1374                     $comment->output(false);
1375                 }
1376             }
1377         }
1378     }
1379 }
1380
1381 /**
1382  * Return rating related permissions
1383  *
1384  * @param string $contextid the context id
1385  * @param string $component the component to get rating permissions for
1386  * @param string $ratingarea the rating area to get permissions for
1387  * @return array an associative array of the user's rating permissions
1388  */
1389 function data_rating_permissions($contextid, $component, $ratingarea) {
1390     $context = get_context_instance_by_id($contextid, MUST_EXIST);
1391     if ($component != 'mod_data' || $ratingarea != 'entry') {
1392         return null;
1393     }
1394     return array(
1395         'view'    => has_capability('mod/data:viewrating',$context),
1396         'viewany' => has_capability('mod/data:viewanyrating',$context),
1397         'viewall' => has_capability('mod/data:viewallratings',$context),
1398         'rate'    => has_capability('mod/data:rate',$context)
1399     );
1400 }
1401
1402 /**
1403  * Validates a submitted rating
1404  * @param array $params submitted data
1405  *            context => object the context in which the rated items exists [required]
1406  *            itemid => int the ID of the object being rated
1407  *            scaleid => int the scale from which the user can select a rating. Used for bounds checking. [required]
1408  *            rating => int the submitted rating
1409  *            rateduserid => int the id of the user whose items have been rated. NOT the user who submitted the ratings. 0 to update all. [required]
1410  *            aggregation => int the aggregation method to apply when calculating grades ie RATING_AGGREGATE_AVERAGE [required]
1411  * @return boolean true if the rating is valid. Will throw rating_exception if not
1412  */
1413 function data_rating_validate($params) {
1414     global $DB, $USER;
1415
1416     // Check the component is mod_data
1417     if ($params['component'] != 'mod_data') {
1418         throw new rating_exception('invalidcomponent');
1419     }
1420
1421     // Check the ratingarea is entry (the only rating area in data module)
1422     if ($params['ratingarea'] != 'entry') {
1423         throw new rating_exception('invalidratingarea');
1424     }
1425
1426     // Check the rateduserid is not the current user .. you can't rate your own entries
1427     if ($params['rateduserid'] == $USER->id) {
1428         throw new rating_exception('nopermissiontorate');
1429     }
1430
1431     $datasql = "SELECT d.id as dataid, d.scale, d.course, r.userid as userid, d.approval, r.approved, r.timecreated, d.assesstimestart, d.assesstimefinish, r.groupid
1432                   FROM {data_records} r
1433                   JOIN {data} d ON r.dataid = d.id
1434                  WHERE r.id = :itemid";
1435     $dataparams = array('itemid'=>$params['itemid']);
1436     if (!$info = $DB->get_record_sql($datasql, $dataparams)) {
1437         //item doesn't exist
1438         throw new rating_exception('invaliditemid');
1439     }
1440
1441     if ($info->scale != $params['scaleid']) {
1442         //the scale being submitted doesnt match the one in the database
1443         throw new rating_exception('invalidscaleid');
1444     }
1445
1446     //check that the submitted rating is valid for the scale
1447
1448     // lower limit
1449     if ($params['rating'] < 0  && $params['rating'] != RATING_UNSET_RATING) {
1450         throw new rating_exception('invalidnum');
1451     }
1452
1453     // upper limit
1454     if ($info->scale < 0) {
1455         //its a custom scale
1456         $scalerecord = $DB->get_record('scale', array('id' => -$info->scale));
1457         if ($scalerecord) {
1458             $scalearray = explode(',', $scalerecord->scale);
1459             if ($params['rating'] > count($scalearray)) {
1460                 throw new rating_exception('invalidnum');
1461             }
1462         } else {
1463             throw new rating_exception('invalidscaleid');
1464         }
1465     } else if ($params['rating'] > $info->scale) {
1466         //if its numeric and submitted rating is above maximum
1467         throw new rating_exception('invalidnum');
1468     }
1469
1470     if ($info->approval && !$info->approved) {
1471         //database requires approval but this item isnt approved
1472         throw new rating_exception('nopermissiontorate');
1473     }
1474
1475     // check the item we're rating was created in the assessable time window
1476     if (!empty($info->assesstimestart) && !empty($info->assesstimefinish)) {
1477         if ($info->timecreated < $info->assesstimestart || $info->timecreated > $info->assesstimefinish) {
1478             throw new rating_exception('notavailable');
1479         }
1480     }
1481
1482     $course = $DB->get_record('course', array('id'=>$info->course), '*', MUST_EXIST);
1483     $cm = get_coursemodule_from_instance('data', $info->dataid, $course->id, false, MUST_EXIST);
1484     $context = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
1485
1486     // if the supplied context doesnt match the item's context
1487     if ($context->id != $params['context']->id) {
1488         throw new rating_exception('invalidcontext');
1489     }
1490
1491     // Make sure groups allow this user to see the item they're rating
1492     $groupid = $info->groupid;
1493     if ($groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
1494         if (!groups_group_exists($groupid)) { // Can't find group
1495             throw new rating_exception('cannotfindgroup');//something is wrong
1496         }
1497
1498         if (!groups_is_member($groupid) and !has_capability('moodle/site:accessallgroups', $context)) {
1499             // do not allow rating of posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
1500             throw new rating_exception('notmemberofgroup');
1501         }
1502     }
1503
1504     return true;
1505 }
1506
1507
1508 /**
1509  * function that takes in the current data, number of items per page,
1510  * a search string and prints a preference box in view.php
1511  *
1512  * This preference box prints a searchable advanced search template if
1513  *     a) A template is defined
1514  *  b) The advanced search checkbox is checked.
1515  *
1516  * @global object
1517  * @global object
1518  * @param object $data
1519  * @param int $perpage
1520  * @param string $search
1521  * @param string $sort
1522  * @param string $order
1523  * @param array $search_array
1524  * @param int $advanced
1525  * @param string $mode
1526  * @return void
1527  */
1528 function data_print_preference_form($data, $perpage, $search, $sort='', $order='ASC', $search_array = '', $advanced = 0, $mode= ''){
1529     global $CFG, $DB, $PAGE, $OUTPUT;
1530
1531     $cm = get_coursemodule_from_instance('data', $data->id);
1532     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1533     echo '<br /><div class="datapreferences">';
1534     echo '<form id="options" action="view.php" method="get">';
1535     echo '<div>';
1536     echo '<input type="hidden" name="d" value="'.$data->id.'" />';
1537     if ($mode =='asearch') {
1538         $advanced = 1;
1539         echo '<input type="hidden" name="mode" value="list" />';
1540     }
1541     echo '<label for="pref_perpage">'.get_string('pagesize','data').'</label> ';
1542     $pagesizes = array(2=>2,3=>3,4=>4,5=>5,6=>6,7=>7,8=>8,9=>9,10=>10,15=>15,
1543                        20=>20,30=>30,40=>40,50=>50,100=>100,200=>200,300=>300,400=>400,500=>500,1000=>1000);
1544     echo html_writer::select($pagesizes, 'perpage', $perpage, false, array('id'=>'pref_perpage'));
1545     echo '<div id="reg_search" style="display: ';
1546     if ($advanced) {
1547         echo 'none';
1548     }
1549     else {
1550         echo 'inline';
1551     }
1552     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>';
1553     echo '&nbsp;&nbsp;&nbsp;<label for="pref_sortby">'.get_string('sortby').'</label> ';
1554     // foreach field, print the option
1555     echo '<select name="sort" id="pref_sortby">';
1556     if ($fields = $DB->get_records('data_fields', array('dataid'=>$data->id), 'name')) {
1557         echo '<optgroup label="'.get_string('fields', 'data').'">';
1558         foreach ($fields as $field) {
1559             if ($field->id == $sort) {
1560                 echo '<option value="'.$field->id.'" selected="selected">'.$field->name.'</option>';
1561             } else {
1562                 echo '<option value="'.$field->id.'">'.$field->name.'</option>';
1563             }
1564         }
1565         echo '</optgroup>';
1566     }
1567     $options = array();
1568     $options[DATA_TIMEADDED]    = get_string('timeadded', 'data');
1569     $options[DATA_TIMEMODIFIED] = get_string('timemodified', 'data');
1570     $options[DATA_FIRSTNAME]    = get_string('authorfirstname', 'data');
1571     $options[DATA_LASTNAME]     = get_string('authorlastname', 'data');
1572     if ($data->approval and has_capability('mod/data:approve', $context)) {
1573         $options[DATA_APPROVED] = get_string('approved', 'data');
1574     }
1575     echo '<optgroup label="'.get_string('other', 'data').'">';
1576     foreach ($options as $key => $name) {
1577         if ($key == $sort) {
1578             echo '<option value="'.$key.'" selected="selected">'.$name.'</option>';
1579         } else {
1580             echo '<option value="'.$key.'">'.$name.'</option>';
1581         }
1582     }
1583     echo '</optgroup>';
1584     echo '</select>';
1585     echo '<label for="pref_order" class="accesshide">'.get_string('order').'</label>';
1586     echo '<select id="pref_order" name="order">';
1587     if ($order == 'ASC') {
1588         echo '<option value="ASC" selected="selected">'.get_string('ascending','data').'</option>';
1589     } else {
1590         echo '<option value="ASC">'.get_string('ascending','data').'</option>';
1591     }
1592     if ($order == 'DESC') {
1593         echo '<option value="DESC" selected="selected">'.get_string('descending','data').'</option>';
1594     } else {
1595         echo '<option value="DESC">'.get_string('descending','data').'</option>';
1596     }
1597     echo '</select>';
1598
1599     if ($advanced) {
1600         $checked = ' checked="checked" ';
1601     }
1602     else {
1603         $checked = '';
1604     }
1605     $PAGE->requires->js('/mod/data/data.js');
1606     echo '&nbsp;<input type="hidden" name="advanced" value="0" />';
1607     echo '&nbsp;<input type="hidden" name="filter" value="1" />';
1608     echo '&nbsp;<input type="checkbox" id="advancedcheckbox" name="advanced" value="1" '.$checked.' onchange="showHideAdvSearch(this.checked);" /><label for="advancedcheckbox">'.get_string('advancedsearch', 'data').'</label>';
1609     echo '&nbsp;<input type="submit" value="'.get_string('savesettings','data').'" />';
1610
1611     echo '<br />';
1612     echo '<div class="dataadvancedsearch" id="data_adv_form" style="display: ';
1613
1614     if ($advanced) {
1615         echo 'inline';
1616     }
1617     else {
1618         echo 'none';
1619     }
1620     echo ';margin-left:auto;margin-right:auto;" >';
1621     echo '<table class="boxaligncenter">';
1622
1623     // print ASC or DESC
1624     echo '<tr><td colspan="2">&nbsp;</td></tr>';
1625     $i = 0;
1626
1627     // Determine if we are printing all fields for advanced search, or the template for advanced search
1628     // If a template is not defined, use the deafault template and display all fields.
1629     if(empty($data->asearchtemplate)) {
1630         data_generate_default_template($data, 'asearchtemplate');
1631     }
1632
1633     static $fields = NULL;
1634     static $isteacher;
1635     static $dataid = NULL;
1636
1637     if (empty($dataid)) {
1638         $dataid = $data->id;
1639     } else if ($dataid != $data->id) {
1640         $fields = NULL;
1641     }
1642
1643     if (empty($fields)) {
1644         $fieldrecords = $DB->get_records('data_fields', array('dataid'=>$data->id));
1645         foreach ($fieldrecords as $fieldrecord) {
1646             $fields[]= data_get_field($fieldrecord, $data);
1647         }
1648
1649         $isteacher = has_capability('mod/data:managetemplates', $context);
1650     }
1651
1652     // Replacing tags
1653     $patterns = array();
1654     $replacement = array();
1655
1656     // Then we generate strings to replace for normal tags
1657     foreach ($fields as $field) {
1658         $fieldname = $field->field->name;
1659         $fieldname = preg_quote($fieldname, '/');
1660         $patterns[] = "/\[\[$fieldname\]\]/i";
1661         $searchfield = data_get_field_from_id($field->field->id, $data);
1662         if (!empty($search_array[$field->field->id]->data)) {
1663             $replacement[] = $searchfield->display_search_field($search_array[$field->field->id]->data);
1664         } else {
1665             $replacement[] = $searchfield->display_search_field();
1666         }
1667     }
1668     $fn = !empty($search_array[DATA_FIRSTNAME]->data) ? $search_array[DATA_FIRSTNAME]->data : '';
1669     $ln = !empty($search_array[DATA_LASTNAME]->data) ? $search_array[DATA_LASTNAME]->data : '';
1670     $patterns[]    = '/##firstname##/';
1671     $replacement[] = '<input type="text" size="16" name="u_fn" value="'.$fn.'" />';
1672     $patterns[]    = '/##lastname##/';
1673     $replacement[] = '<input type="text" size="16" name="u_ln" value="'.$ln.'" />';
1674
1675     // actual replacement of the tags
1676     $newtext = preg_replace($patterns, $replacement, $data->asearchtemplate);
1677
1678     $options = new stdClass();
1679     $options->para=false;
1680     $options->noclean=true;
1681     echo '<tr><td>';
1682     echo format_text($newtext, FORMAT_HTML, $options);
1683     echo '</td></tr>';
1684
1685     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>';
1686     echo '</table>';
1687     echo '</div>';
1688     echo '</div>';
1689     echo '</form>';
1690     echo '</div>';
1691 }
1692
1693 /**
1694  * @global object
1695  * @global object
1696  * @param object $data
1697  * @param object $record
1698  * @return void Output echo'd
1699  */
1700 function data_print_ratings($data, $record) {
1701     global $OUTPUT;
1702     if (!empty($record->rating)){
1703         echo $OUTPUT->render($record->rating);
1704     }
1705 }
1706
1707 /**
1708  * For Participantion Reports
1709  *
1710  * @return array
1711  */
1712 function data_get_view_actions() {
1713     return array('view');
1714 }
1715
1716 /**
1717  * @return array
1718  */
1719 function data_get_post_actions() {
1720     return array('add','update','record delete');
1721 }
1722
1723 /**
1724  * @param string $name
1725  * @param int $dataid
1726  * @param int $fieldid
1727  * @return bool
1728  */
1729 function data_fieldname_exists($name, $dataid, $fieldid = 0) {
1730     global $DB;
1731
1732     if (!is_numeric($name)) {
1733         $like = $DB->sql_like('df.name', ':name', false);
1734     } else {
1735         $like = "df.name = :name";
1736     }
1737     $params = array('name'=>$name);
1738     if ($fieldid) {
1739         $params['dataid']   = $dataid;
1740         $params['fieldid1'] = $fieldid;
1741         $params['fieldid2'] = $fieldid;
1742         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1743                                         WHERE $like AND df.dataid = :dataid
1744                                               AND ((df.id < :fieldid1) OR (df.id > :fieldid2))", $params);
1745     } else {
1746         $params['dataid']   = $dataid;
1747         return $DB->record_exists_sql("SELECT * FROM {data_fields} df
1748                                         WHERE $like AND df.dataid = :dataid", $params);
1749     }
1750 }
1751
1752 /**
1753  * @param array $fieldinput
1754  */
1755 function data_convert_arrays_to_strings(&$fieldinput) {
1756     foreach ($fieldinput as $key => $val) {
1757         if (is_array($val)) {
1758             $str = '';
1759             foreach ($val as $inner) {
1760                 $str .= $inner . ',';
1761             }
1762             $str = substr($str, 0, -1);
1763
1764             $fieldinput->$key = $str;
1765         }
1766     }
1767 }
1768
1769
1770 /**
1771  * Converts a database (module instance) to use the Roles System
1772  *
1773  * @global object
1774  * @global object
1775  * @uses CONTEXT_MODULE
1776  * @uses CAP_PREVENT
1777  * @uses CAP_ALLOW
1778  * @param object $data a data object with the same attributes as a record
1779  *                     from the data database table
1780  * @param int $datamodid the id of the data module, from the modules table
1781  * @param array $teacherroles array of roles that have archetype teacher
1782  * @param array $studentroles array of roles that have archetype student
1783  * @param array $guestroles array of roles that have archetype guest
1784  * @param int $cmid the course_module id for this data instance
1785  * @return boolean data module was converted or not
1786  */
1787 function data_convert_to_roles($data, $teacherroles=array(), $studentroles=array(), $cmid=NULL) {
1788     global $CFG, $DB, $OUTPUT;
1789
1790     if (!isset($data->participants) && !isset($data->assesspublic)
1791             && !isset($data->groupmode)) {
1792         // We assume that this database has already been converted to use the
1793         // Roles System. above fields get dropped the data module has been
1794         // upgraded to use Roles.
1795         return false;
1796     }
1797
1798     if (empty($cmid)) {
1799         // We were not given the course_module id. Try to find it.
1800         if (!$cm = get_coursemodule_from_instance('data', $data->id)) {
1801             echo $OUTPUT->notification('Could not get the course module for the data');
1802             return false;
1803         } else {
1804             $cmid = $cm->id;
1805         }
1806     }
1807     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1808
1809
1810     // $data->participants:
1811     // 1 - Only teachers can add entries
1812     // 3 - Teachers and students can add entries
1813     switch ($data->participants) {
1814         case 1:
1815             foreach ($studentroles as $studentrole) {
1816                 assign_capability('mod/data:writeentry', CAP_PREVENT, $studentrole->id, $context->id);
1817             }
1818             foreach ($teacherroles as $teacherrole) {
1819                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1820             }
1821             break;
1822         case 3:
1823             foreach ($studentroles as $studentrole) {
1824                 assign_capability('mod/data:writeentry', CAP_ALLOW, $studentrole->id, $context->id);
1825             }
1826             foreach ($teacherroles as $teacherrole) {
1827                 assign_capability('mod/data:writeentry', CAP_ALLOW, $teacherrole->id, $context->id);
1828             }
1829             break;
1830     }
1831
1832     // $data->assessed:
1833     // 2 - Only teachers can rate posts
1834     // 1 - Everyone can rate posts
1835     // 0 - No one can rate posts
1836     switch ($data->assessed) {
1837         case 0:
1838             foreach ($studentroles as $studentrole) {
1839                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1840             }
1841             foreach ($teacherroles as $teacherrole) {
1842                 assign_capability('mod/data:rate', CAP_PREVENT, $teacherrole->id, $context->id);
1843             }
1844             break;
1845         case 1:
1846             foreach ($studentroles as $studentrole) {
1847                 assign_capability('mod/data:rate', CAP_ALLOW, $studentrole->id, $context->id);
1848             }
1849             foreach ($teacherroles as $teacherrole) {
1850                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1851             }
1852             break;
1853         case 2:
1854             foreach ($studentroles as $studentrole) {
1855                 assign_capability('mod/data:rate', CAP_PREVENT, $studentrole->id, $context->id);
1856             }
1857             foreach ($teacherroles as $teacherrole) {
1858                 assign_capability('mod/data:rate', CAP_ALLOW, $teacherrole->id, $context->id);
1859             }
1860             break;
1861     }
1862
1863     // $data->assesspublic:
1864     // 0 - Students can only see their own ratings
1865     // 1 - Students can see everyone's ratings
1866     switch ($data->assesspublic) {
1867         case 0:
1868             foreach ($studentroles as $studentrole) {
1869                 assign_capability('mod/data:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
1870             }
1871             foreach ($teacherroles as $teacherrole) {
1872                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1873             }
1874             break;
1875         case 1:
1876             foreach ($studentroles as $studentrole) {
1877                 assign_capability('mod/data:viewrating', CAP_ALLOW, $studentrole->id, $context->id);
1878             }
1879             foreach ($teacherroles as $teacherrole) {
1880                 assign_capability('mod/data:viewrating', CAP_ALLOW, $teacherrole->id, $context->id);
1881             }
1882             break;
1883     }
1884
1885     if (empty($cm)) {
1886         $cm = $DB->get_record('course_modules', array('id'=>$cmid));
1887     }
1888
1889     switch ($cm->groupmode) {
1890         case NOGROUPS:
1891             break;
1892         case SEPARATEGROUPS:
1893             foreach ($studentroles as $studentrole) {
1894                 assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
1895             }
1896             foreach ($teacherroles as $teacherrole) {
1897                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1898             }
1899             break;
1900         case VISIBLEGROUPS:
1901             foreach ($studentroles as $studentrole) {
1902                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
1903             }
1904             foreach ($teacherroles as $teacherrole) {
1905                 assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
1906             }
1907             break;
1908     }
1909     return true;
1910 }
1911
1912 /**
1913  * Returns the best name to show for a preset
1914  *
1915  * @param string $shortname
1916  * @param  string $path
1917  * @return string
1918  */
1919 function data_preset_name($shortname, $path) {
1920
1921     // We are looking inside the preset itself as a first choice, but also in normal data directory
1922     $string = get_string('modulename', 'datapreset_'.$shortname);
1923
1924     if (substr($string, 0, 1) == '[') {
1925         return $shortname;
1926     } else {
1927         return $string;
1928     }
1929 }
1930
1931 /**
1932  * Returns an array of all the available presets.
1933  *
1934  * @return array
1935  */
1936 function data_get_available_presets($context) {
1937     global $CFG, $USER;
1938
1939     $presets = array();
1940
1941     // First load the ratings sub plugins that exist within the modules preset dir
1942     if ($dirs = get_list_of_plugins('mod/data/preset')) {
1943         foreach ($dirs as $dir) {
1944             $fulldir = $CFG->dirroot.'/mod/data/preset/'.$dir;
1945             if (is_directory_a_preset($fulldir)) {
1946                 $preset = new stdClass();
1947                 $preset->path = $fulldir;
1948                 $preset->userid = 0;
1949                 $preset->shortname = $dir;
1950                 $preset->name = data_preset_name($dir, $fulldir);
1951                 if (file_exists($fulldir.'/screenshot.jpg')) {
1952                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.jpg';
1953                 } else if (file_exists($fulldir.'/screenshot.png')) {
1954                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.png';
1955                 } else if (file_exists($fulldir.'/screenshot.gif')) {
1956                     $preset->screenshot = $CFG->wwwroot.'/mod/data/preset/'.$dir.'/screenshot.gif';
1957                 }
1958                 $presets[] = $preset;
1959             }
1960         }
1961     }
1962     // Now add to that the site presets that people have saved
1963     $presets = data_get_available_site_presets($context, $presets);
1964     return $presets;
1965 }
1966
1967 /**
1968  * Gets an array of all of the presets that users have saved to the site.
1969  *
1970  * @param stdClass $context The context that we are looking from.
1971  * @param array $presets
1972  * @return array An array of presets
1973  */
1974 function data_get_available_site_presets($context, array $presets=array()) {
1975     global $USER;
1976
1977     $fs = get_file_storage();
1978     $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
1979     $canviewall = has_capability('mod/data:viewalluserpresets', $context);
1980     if (empty($files)) {
1981         return $presets;
1982     }
1983     foreach ($files as $file) {
1984         if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory() || (!$canviewall && $file->get_userid() != $USER->id)) {
1985             continue;
1986         }
1987         $preset = new stdClass;
1988         $preset->path = $file->get_filepath();
1989         $preset->name = trim($preset->path, '/');
1990         $preset->shortname = $preset->name;
1991         $preset->userid = $file->get_userid();
1992         $preset->id = $file->get_id();
1993         $preset->storedfile = $file;
1994         $presets[] = $preset;
1995     }
1996     return $presets;
1997 }
1998
1999 /**
2000  * Deletes a saved preset.
2001  *
2002  * @param string $name
2003  * @return bool
2004  */
2005 function data_delete_site_preset($name) {
2006     $fs = get_file_storage();
2007
2008     $files = $fs->get_directory_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/');
2009     if (!empty($files)) {
2010         foreach ($files as $file) {
2011             $file->delete();
2012         }
2013     }
2014
2015     $dir = $fs->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, '/'.$name.'/', '.');
2016     if (!empty($dir)) {
2017         $dir->delete();
2018     }
2019     return true;
2020 }
2021
2022 /**
2023  * Prints the heads for a page
2024  *
2025  * @param stdClass $course
2026  * @param stdClass $cm
2027  * @param stdClass $data
2028  * @param string $currenttab
2029  */
2030 function data_print_header($course, $cm, $data, $currenttab='') {
2031
2032     global $CFG, $displaynoticegood, $displaynoticebad, $OUTPUT, $PAGE;
2033
2034     $PAGE->set_title($data->name);
2035     echo $OUTPUT->header();
2036     echo $OUTPUT->heading(format_string($data->name));
2037
2038 // Groups needed for Add entry tab
2039     $currentgroup = groups_get_activity_group($cm);
2040     $groupmode = groups_get_activity_groupmode($cm);
2041
2042     // Print the tabs
2043
2044     if ($currenttab) {
2045         include('tabs.php');
2046     }
2047
2048     // Print any notices
2049
2050     if (!empty($displaynoticegood)) {
2051         echo $OUTPUT->notification($displaynoticegood, 'notifysuccess');    // good (usually green)
2052     } else if (!empty($displaynoticebad)) {
2053         echo $OUTPUT->notification($displaynoticebad);                     // bad (usuually red)
2054     }
2055 }
2056
2057 /**
2058  * Can user add more entries?
2059  *
2060  * @param object $data
2061  * @param mixed $currentgroup
2062  * @param int $groupmode
2063  * @param stdClass $context
2064  * @return bool
2065  */
2066 function data_user_can_add_entry($data, $currentgroup, $groupmode, $context = null) {
2067     global $USER;
2068
2069     if (empty($context)) {
2070         $cm = get_coursemodule_from_instance('data', $data->id, 0, false, MUST_EXIST);
2071         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2072     }
2073
2074     if (has_capability('mod/data:manageentries', $context)) {
2075         // no entry limits apply if user can manage
2076
2077     } else if (!has_capability('mod/data:writeentry', $context)) {
2078         return false;
2079
2080     } else if (data_atmaxentries($data)) {
2081         return false;
2082     }
2083
2084     //if in the view only time window
2085     $now = time();
2086     if ($now>$data->timeviewfrom && $now<$data->timeviewto) {
2087         return false;
2088     }
2089
2090     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
2091         return true;
2092     }
2093
2094     if ($currentgroup) {
2095         return groups_is_member($currentgroup);
2096     } else {
2097         //else it might be group 0 in visible mode
2098         if ($groupmode == VISIBLEGROUPS){
2099             return true;
2100         } else {
2101             return false;
2102         }
2103     }
2104 }
2105
2106
2107 /**
2108  * @return bool
2109  */
2110 function is_directory_a_preset($directory) {
2111     $directory = rtrim($directory, '/\\') . '/';
2112     $status = file_exists($directory.'singletemplate.html') &&
2113               file_exists($directory.'listtemplate.html') &&
2114               file_exists($directory.'listtemplateheader.html') &&
2115               file_exists($directory.'listtemplatefooter.html') &&
2116               file_exists($directory.'addtemplate.html') &&
2117               file_exists($directory.'rsstemplate.html') &&
2118               file_exists($directory.'rsstitletemplate.html') &&
2119               file_exists($directory.'csstemplate.css') &&
2120               file_exists($directory.'jstemplate.js') &&
2121               file_exists($directory.'preset.xml');
2122
2123     return $status;
2124 }
2125
2126 /**
2127  * Abstract class used for data preset importers
2128  */
2129 abstract class data_preset_importer {
2130
2131     protected $course;
2132     protected $cm;
2133     protected $module;
2134     protected $directory;
2135
2136     /**
2137      * Constructor
2138      *
2139      * @param stdClass $course
2140      * @param stdClass $cm
2141      * @param stdClass $module
2142      * @param string $directory
2143      */
2144     public function __construct($course, $cm, $module, $directory) {
2145         $this->course = $course;
2146         $this->cm = $cm;
2147         $this->module = $module;
2148         $this->directory = $directory;
2149     }
2150
2151     /**
2152      * Returns the name of the directory the preset is located in
2153      * @return string
2154      */
2155     public function get_directory() {
2156         return basename($this->directory);
2157     }
2158
2159     /**
2160      * Retreive the contents of a file. That file may either be in a conventional directory of the Moodle file storage
2161      * @param file_storage $filestorage. should be null if using a conventional directory
2162      * @param stored_file $fileobj the directory to look in. null if using a conventional directory
2163      * @param string $dir the directory to look in. null if using the Moodle file storage
2164      * @param string $filename the name of the file we want
2165      * @return string the contents of the file
2166      */
2167     public function data_preset_get_file_contents(&$filestorage, &$fileobj, $dir, $filename) {
2168         if(empty($filestorage) || empty($fileobj)) {
2169             if (substr($dir, -1)!='/') {
2170                 $dir .= '/';
2171             }
2172             return file_get_contents($dir.$filename);
2173         } else {
2174             $file = $filestorage->get_file(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA, 0, $fileobj->get_filepath(), $filename);
2175             return $file->get_content();
2176         }
2177
2178     }
2179     /**
2180      * Gets the preset settings
2181      * @global moodle_database $DB
2182      * @return stdClass
2183      */
2184     public function get_preset_settings() {
2185         global $DB;
2186
2187         $fs = $fileobj = null;
2188         if (!is_directory_a_preset($this->directory)) {
2189             //maybe the user requested a preset stored in the Moodle file storage
2190
2191             $fs = get_file_storage();
2192             $files = $fs->get_area_files(DATA_PRESET_CONTEXT, DATA_PRESET_COMPONENT, DATA_PRESET_FILEAREA);
2193
2194             //preset name to find will be the final element of the directory
2195             $presettofind = end(explode('/',$this->directory));
2196
2197             //now go through the available files available and see if we can find it
2198             foreach ($files as $file) {
2199                 if (($file->is_directory() && $file->get_filepath()=='/') || !$file->is_directory()) {
2200                     continue;
2201                 }
2202                 $presetname = trim($file->get_filepath(), '/');
2203                 if ($presetname==$presettofind) {
2204                     $this->directory = $presetname;
2205                     $fileobj = $file;
2206                 }
2207             }
2208
2209             if (empty($fileobj)) {
2210                 print_error('invalidpreset', 'data', '', $this->directory);
2211             }
2212         }
2213
2214         $allowed_settings = array(
2215             'intro',
2216             'comments',
2217             'requiredentries',
2218             'requiredentriestoview',
2219             'maxentries',
2220             'rssarticles',
2221             'approval',
2222             'defaultsortdir',
2223             'defaultsort');
2224
2225         $result = new stdClass;
2226         $result->settings = new stdClass;
2227         $result->importfields = array();
2228         $result->currentfields = $DB->get_records('data_fields', array('dataid'=>$this->module->id));
2229         if (!$result->currentfields) {
2230             $result->currentfields = array();
2231         }
2232
2233
2234         /* Grab XML */
2235         $presetxml = $this->data_preset_get_file_contents($fs, $fileobj, $this->directory,'preset.xml');
2236         $parsedxml = xmlize($presetxml, 0);
2237
2238         /* First, do settings. Put in user friendly array. */
2239         $settingsarray = $parsedxml['preset']['#']['settings'][0]['#'];
2240         $result->settings = new StdClass();
2241         foreach ($settingsarray as $setting => $value) {
2242             if (!is_array($value) || !in_array($setting, $allowed_settings)) {
2243                 // unsupported setting
2244                 continue;
2245             }
2246             $result->settings->$setting = $value[0]['#'];
2247         }
2248
2249         /* Now work out fields to user friendly array */
2250         $fieldsarray = $parsedxml['preset']['#']['field'];
2251         foreach ($fieldsarray as $field) {
2252             if (!is_array($field)) {
2253                 continue;
2254             }
2255             $f = new StdClass();
2256             foreach ($field['#'] as $param => $value) {
2257                 if (!is_array($value)) {
2258                     continue;
2259                 }
2260                 $f->$param = $value[0]['#'];
2261             }
2262             $f->dataid = $this->module->id;
2263             $f->type = clean_param($f->type, PARAM_ALPHA);
2264             $result->importfields[] = $f;
2265         }
2266         /* Now add the HTML templates to the settings array so we can update d */
2267         $result->settings->singletemplate     = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"singletemplate.html");
2268         $result->settings->listtemplate       = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplate.html");
2269         $result->settings->listtemplateheader = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplateheader.html");
2270         $result->settings->listtemplatefooter = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"listtemplatefooter.html");
2271         $result->settings->addtemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"addtemplate.html");
2272         $result->settings->rsstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstemplate.html");
2273         $result->settings->rsstitletemplate   = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"rsstitletemplate.html");
2274         $result->settings->csstemplate        = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"csstemplate.css");
2275         $result->settings->jstemplate         = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"jstemplate.js");
2276
2277         //optional
2278         if (file_exists($this->directory."/asearchtemplate.html")) {
2279             $result->settings->asearchtemplate = $this->data_preset_get_file_contents($fs, $fileobj,$this->directory,"asearchtemplate.html");
2280         } else {
2281             $result->settings->asearchtemplate = NULL;
2282         }
2283         $result->settings->instance = $this->module->id;
2284
2285         return $result;
2286     }
2287
2288     /**
2289      * Import the preset into the given database module
2290      * @return bool
2291      */
2292     function import($overwritesettings) {
2293         global $DB, $CFG;
2294
2295         $params = $this->get_preset_settings();
2296         $settings = $params->settings;
2297         $newfields = $params->importfields;
2298         $currentfields = $params->currentfields;
2299         $preservedfields = array();
2300
2301         /* Maps fields and makes new ones */
2302         if (!empty($newfields)) {
2303             /* We require an injective mapping, and need to know what to protect */
2304             foreach ($newfields as $nid => $newfield) {
2305                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2306                 if ($cid == -1) {
2307                     continue;
2308                 }
2309                 if (array_key_exists($cid, $preservedfields)){
2310                     print_error('notinjectivemap', 'data');
2311                 }
2312                 else $preservedfields[$cid] = true;
2313             }
2314
2315             foreach ($newfields as $nid => $newfield) {
2316                 $cid = optional_param("field_$nid", -1, PARAM_INT);
2317
2318                 /* A mapping. Just need to change field params. Data kept. */
2319                 if ($cid != -1 and isset($currentfields[$cid])) {
2320                     $fieldobject = data_get_field_from_id($currentfields[$cid]->id, $this->module);
2321                     foreach ($newfield as $param => $value) {
2322                         if ($param != "id") {
2323                             $fieldobject->field->$param = $value;
2324                         }
2325                     }
2326                     unset($fieldobject->field->similarfield);
2327                     $fieldobject->update_field();
2328                     unset($fieldobject);
2329                 } else {
2330                     /* Make a new field */
2331                     include_once("field/$newfield->type/field.class.php");
2332
2333                     if (!isset($newfield->description)) {
2334                         $newfield->description = '';
2335                     }
2336                     $classname = 'data_field_'.$newfield->type;
2337                     $fieldclass = new $classname($newfield, $this->module);
2338                     $fieldclass->insert_field();
2339                     unset($fieldclass);
2340                 }
2341             }
2342         }
2343
2344         /* Get rid of all old unused data */
2345         if (!empty($preservedfields)) {
2346             foreach ($currentfields as $cid => $currentfield) {
2347                 if (!array_key_exists($cid, $preservedfields)) {
2348                     /* Data not used anymore so wipe! */
2349                     print "Deleting field $currentfield->name<br />";
2350
2351                     $id = $currentfield->id;
2352                     //Why delete existing data records and related comments/ratings??
2353                     $DB->delete_records('data_content', array('fieldid'=>$id));
2354                     $DB->delete_records('data_fields', array('id'=>$id));
2355                 }
2356             }
2357         }
2358
2359         // handle special settings here
2360         if (!empty($settings->defaultsort)) {
2361             if (is_numeric($settings->defaultsort)) {
2362                 // old broken value
2363                 $settings->defaultsort = 0;
2364             } else {
2365                 $settings->defaultsort = (int)$DB->get_field('data_fields', 'id', array('dataid'=>$this->module->id, 'name'=>$settings->defaultsort));
2366             }
2367         } else {
2368             $settings->defaultsort = 0;
2369         }
2370
2371         // do we want to overwrite all current database settings?
2372         if ($overwritesettings) {
2373             // all supported settings
2374             $overwrite = array_keys((array)$settings);
2375         } else {
2376             // only templates and sorting
2377             $overwrite = array('singletemplate', 'listtemplate', 'listtemplateheader', 'listtemplatefooter',
2378                                'addtemplate', 'rsstemplate', 'rsstitletemplate', 'csstemplate', 'jstemplate',
2379                                'asearchtemplate', 'defaultsortdir', 'defaultsort');
2380         }
2381
2382         // now overwrite current data settings
2383         foreach ($this->module as $prop=>$unused) {
2384             if (in_array($prop, $overwrite)) {
2385                 $this->module->$prop = $settings->$prop;
2386             }
2387         }
2388
2389         data_update_instance($this->module);
2390
2391         return $this->cleanup();
2392     }
2393
2394     /**
2395      * Any clean up routines should go here
2396      * @return bool
2397      */
2398     public function cleanup() {
2399         return true;
2400     }
2401 }
2402
2403 /**
2404  * Data preset importer for uploaded presets
2405  */
2406 class data_preset_upload_importer extends data_preset_importer {
2407     public function __construct($course, $cm, $module, $filepath) {
2408         global $USER;
2409         if (is_file($filepath)) {
2410             $fp = get_file_packer();
2411             if ($fp->extract_to_pathname($filepath, $filepath.'_extracted')) {
2412                 fulldelete($filepath);
2413             }
2414             $filepath .= '_extracted';
2415         }
2416         parent::__construct($course, $cm, $module, $filepath);
2417     }
2418     public function cleanup() {
2419         return fulldelete($this->directory);
2420     }
2421 }
2422
2423 /**
2424  * Data preset importer for existing presets
2425  */
2426 class data_preset_existing_importer extends data_preset_importer {
2427     protected $userid;
2428     public function __construct($course, $cm, $module, $fullname) {
2429         global $USER;
2430         list($userid, $shortname) = explode('/', $fullname, 2);
2431         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2432         if ($userid && ($userid != $USER->id) && !has_capability('mod/data:manageuserpresets', $context) && !has_capability('mod/data:viewalluserpresets', $context)) {
2433            throw new coding_exception('Invalid preset provided');
2434         }
2435
2436         $this->userid = $userid;
2437         $filepath = data_preset_path($course, $userid, $shortname);
2438         parent::__construct($course, $cm, $module, $filepath);
2439     }
2440     public function get_userid() {
2441         return $this->userid;
2442     }
2443 }
2444
2445 /**
2446  * @global object
2447  * @global object
2448  * @param object $course
2449  * @param int $userid
2450  * @param string $shortname
2451  * @return string
2452  */
2453 function data_preset_path($course, $userid, $shortname) {
2454     global $USER, $CFG;
2455
2456     $context = get_context_instance(CONTEXT_COURSE, $course->id);
2457
2458     $userid = (int)$userid;
2459
2460     $path = null;
2461     if ($userid > 0 && ($userid == $USER->id || has_capability('mod/data:viewalluserpresets', $context))) {
2462         $path = $CFG->dataroot.'/data/preset/'.$userid.'/'.$shortname;
2463     } else if ($userid == 0) {
2464         $path = $CFG->dirroot.'/mod/data/preset/'.$shortname;
2465     } else if ($userid < 0) {
2466         $path = $CFG->tempdir.'/data/'.-$userid.'/'.$shortname;
2467     }
2468
2469     return $path;
2470 }
2471
2472 /**
2473  * Implementation of the function for printing the form elements that control
2474  * whether the course reset functionality affects the data.
2475  *
2476  * @param $mform form passed by reference
2477  */
2478 function data_reset_course_form_definition(&$mform) {
2479     $mform->addElement('header', 'dataheader', get_string('modulenameplural', 'data'));
2480     $mform->addElement('checkbox', 'reset_data', get_string('deleteallentries','data'));
2481
2482     $mform->addElement('checkbox', 'reset_data_notenrolled', get_string('deletenotenrolled', 'data'));
2483     $mform->disabledIf('reset_data_notenrolled', 'reset_data', 'checked');
2484
2485     $mform->addElement('checkbox', 'reset_data_ratings', get_string('deleteallratings'));
2486     $mform->disabledIf('reset_data_ratings', 'reset_data', 'checked');
2487
2488     $mform->addElement('checkbox', 'reset_data_comments', get_string('deleteallcomments'));
2489     $mform->disabledIf('reset_data_comments', 'reset_data', 'checked');
2490 }
2491
2492 /**
2493  * Course reset form defaults.
2494  * @return array
2495  */
2496 function data_reset_course_form_defaults($course) {
2497     return array('reset_data'=>0, 'reset_data_ratings'=>1, 'reset_data_comments'=>1, 'reset_data_notenrolled'=>0);
2498 }
2499
2500 /**
2501  * Removes all grades from gradebook
2502  *
2503  * @global object
2504  * @global object
2505  * @param int $courseid
2506  * @param string $type optional type
2507  */
2508 function data_reset_gradebook($courseid, $type='') {
2509     global $CFG, $DB;
2510
2511     $sql = "SELECT d.*, cm.idnumber as cmidnumber, d.course as courseid
2512               FROM {data} d, {course_modules} cm, {modules} m
2513              WHERE m.name='data' AND m.id=cm.module AND cm.instance=d.id AND d.course=?";
2514
2515     if ($datas = $DB->get_records_sql($sql, array($courseid))) {
2516         foreach ($datas as $data) {
2517             data_grade_item_update($data, 'reset');
2518         }
2519     }
2520 }
2521
2522 /**
2523  * Actual implementation of the reset course functionality, delete all the
2524  * data responses for course $data->courseid.
2525  *
2526  * @global object
2527  * @global object
2528  * @param object $data the data submitted from the reset course.
2529  * @return array status array
2530  */
2531 function data_reset_userdata($data) {
2532     global $CFG, $DB;
2533     require_once($CFG->libdir.'/filelib.php');
2534     require_once($CFG->dirroot.'/rating/lib.php');
2535
2536     $componentstr = get_string('modulenameplural', 'data');
2537     $status = array();
2538
2539     $allrecordssql = "SELECT r.id
2540                         FROM {data_records} r
2541                              INNER JOIN {data} d ON r.dataid = d.id
2542                        WHERE d.course = ?";
2543
2544     $alldatassql = "SELECT d.id
2545                       FROM {data} d
2546                      WHERE d.course=?";
2547
2548     $rm = new rating_manager();
2549     $ratingdeloptions = new stdClass;
2550     $ratingdeloptions->component = 'mod_data';
2551     $ratingdeloptions->ratingarea = 'entry';
2552
2553     // delete entries if requested
2554     if (!empty($data->reset_data)) {
2555         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2556         $DB->delete_records_select('data_content', "recordid IN ($allrecordssql)", array($data->courseid));
2557         $DB->delete_records_select('data_records', "dataid IN ($alldatassql)", array($data->courseid));
2558
2559         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2560             foreach ($datas as $dataid=>$unused) {
2561                 fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$dataid");
2562
2563                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2564                     continue;
2565                 }
2566                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2567
2568                 $ratingdeloptions->contextid = $datacontext->id;
2569                 $rm->delete_ratings($ratingdeloptions);
2570             }
2571         }
2572
2573         if (empty($data->reset_gradebook_grades)) {
2574             // remove all grades from gradebook
2575             data_reset_gradebook($data->courseid);
2576         }
2577         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallentries', 'data'), 'error'=>false);
2578     }
2579
2580     // remove entries by users not enrolled into course
2581     if (!empty($data->reset_data_notenrolled)) {
2582         $recordssql = "SELECT r.id, r.userid, r.dataid, u.id AS userexists, u.deleted AS userdeleted
2583                          FROM {data_records} r
2584                               JOIN {data} d ON r.dataid = d.id
2585                               LEFT JOIN {user} u ON r.userid = u.id
2586                         WHERE d.course = ? AND r.userid > 0";
2587
2588         $course_context = get_context_instance(CONTEXT_COURSE, $data->courseid);
2589         $notenrolled = array();
2590         $fields = array();
2591         $rs = $DB->get_recordset_sql($recordssql, array($data->courseid));
2592         foreach ($rs as $record) {
2593             if (array_key_exists($record->userid, $notenrolled) or !$record->userexists or $record->userdeleted
2594               or !is_enrolled($course_context, $record->userid)) {
2595                 //delete ratings
2596                 if (!$cm = get_coursemodule_from_instance('data', $record->dataid)) {
2597                     continue;
2598                 }
2599                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2600                 $ratingdeloptions->contextid = $datacontext->id;
2601                 $ratingdeloptions->itemid = $record->id;
2602                 $rm->delete_ratings($ratingdeloptions);
2603
2604                 $DB->delete_records('comments', array('itemid'=>$record->id, 'commentarea'=>'database_entry'));
2605                 $DB->delete_records('data_content', array('recordid'=>$record->id));
2606                 $DB->delete_records('data_records', array('id'=>$record->id));
2607                 // HACK: this is ugly - the recordid should be before the fieldid!
2608                 if (!array_key_exists($record->dataid, $fields)) {
2609                     if ($fs = $DB->get_records('data_fields', array('dataid'=>$record->dataid))) {
2610                         $fields[$record->dataid] = array_keys($fs);
2611                     } else {
2612                         $fields[$record->dataid] = array();
2613                     }
2614                 }
2615                 foreach($fields[$record->dataid] as $fieldid) {
2616                     fulldelete("$CFG->dataroot/$data->courseid/moddata/data/$record->dataid/$fieldid/$record->id");
2617                 }
2618                 $notenrolled[$record->userid] = true;
2619             }
2620         }
2621         $rs->close();
2622         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotenrolled', 'data'), 'error'=>false);
2623     }
2624
2625     // remove all ratings
2626     if (!empty($data->reset_data_ratings)) {
2627         if ($datas = $DB->get_records_sql($alldatassql, array($data->courseid))) {
2628             foreach ($datas as $dataid=>$unused) {
2629                 if (!$cm = get_coursemodule_from_instance('data', $dataid)) {
2630                     continue;
2631                 }
2632                 $datacontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2633
2634                 $ratingdeloptions->contextid = $datacontext->id;
2635                 $rm->delete_ratings($ratingdeloptions);
2636             }
2637         }
2638
2639         if (empty($data->reset_gradebook_grades)) {
2640             // remove all grades from gradebook
2641             data_reset_gradebook($data->courseid);
2642         }
2643
2644         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallratings'), 'error'=>false);
2645     }
2646
2647     // remove all comments
2648     if (!empty($data->reset_data_comments)) {
2649         $DB->delete_records_select('comments', "itemid IN ($allrecordssql) AND commentarea='database_entry'", array($data->courseid));
2650         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallcomments'), 'error'=>false);
2651     }
2652
2653     // updating dates - shift may be negative too
2654     if ($data->timeshift) {
2655         shift_course_mod_dates('data', array('timeavailablefrom', 'timeavailableto', 'timeviewfrom', 'timeviewto'), $data->timeshift, $data->courseid);
2656         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
2657     }
2658
2659     return $status;
2660 }
2661
2662 /**
2663  * Returns all other caps used in module
2664  *
2665  * @return array
2666  */
2667 function data_get_extra_capabilities() {
2668     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/rating:view', 'moodle/rating:viewany', 'moodle/rating:viewall', 'moodle/rating:rate', 'moodle/comment:view', 'moodle/comment:post', 'moodle/comment:delete');
2669 }
2670
2671 /**
2672  * @param string $feature FEATURE_xx constant for requested feature
2673  * @return mixed True if module supports feature, null if doesn't know
2674  */
2675 function data_supports($feature) {
2676     switch($feature) {
2677         case FEATURE_GROUPS:                  return true;
2678         case FEATURE_GROUPINGS:               return true;
2679         case FEATURE_GROUPMEMBERSONLY:        return true;
2680         case FEATURE_MOD_INTRO:               return true;
2681         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
2682         case FEATURE_GRADE_HAS_GRADE:         return true;
2683         case FEATURE_GRADE_OUTCOMES:          return true;
2684         case FEATURE_RATE:                    return true;
2685         case FEATURE_BACKUP_MOODLE2:          return true;
2686         case FEATURE_SHOW_DESCRIPTION:        return true;
2687
2688         default: return null;
2689     }
2690 }
2691 /**
2692  * @global object
2693  * @param array $export
2694  * @param string $delimiter_name
2695  * @param object $database
2696  * @param int $count
2697  * @param bool $return
2698  * @return string|void
2699  */
2700 function data_export_csv($export, $delimiter_name, $dataname, $count, $return=false) {
2701     global $CFG;
2702     require_once($CFG->libdir . '/csvlib.class.php');
2703     $delimiter = csv_import_reader::get_delimiter($delimiter_name);
2704     $filename = clean_filename("{$dataname}-{$count}_record");
2705     if ($count > 1) {
2706         $filename .= 's';
2707     }
2708     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2709     $filename .= clean_filename("-{$delimiter_name}_separated");
2710     $filename .= '.csv';
2711     if (empty($return)) {
2712         header("Content-Type: application/download\n");
2713         header("Content-Disposition: attachment; filename=$filename");
2714         header('Expires: 0');
2715         header('Cache-Control: must-revalidate,post-check=0,pre-check=0');
2716         header('Pragma: public');
2717     }
2718     $encdelim = '&#' . ord($delimiter) . ';';
2719     $returnstr = '';
2720     foreach($export as $row) {
2721         foreach($row as $key => $column) {
2722             $row[$key] = str_replace($delimiter, $encdelim, $column);
2723         }
2724         $returnstr .= implode($delimiter, $row) . "\n";
2725     }
2726     if (empty($return)) {
2727         echo $returnstr;
2728         return;
2729     }
2730     return $returnstr;
2731 }
2732
2733 /**
2734  * @global object
2735  * @param array $export
2736  * @param string $dataname
2737  * @param int $count
2738  * @return string
2739  */
2740 function data_export_xls($export, $dataname, $count) {
2741     global $CFG;
2742     require_once("$CFG->libdir/excellib.class.php");
2743     $filename = clean_filename("{$dataname}-{$count}_record");
2744     if ($count > 1) {
2745         $filename .= 's';
2746     }
2747     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2748     $filename .= '.xls';
2749
2750     $filearg = '-';
2751     $workbook = new MoodleExcelWorkbook($filearg);
2752     $workbook->send($filename);
2753     $worksheet = array();
2754     $worksheet[0] =& $workbook->add_worksheet('');
2755     $rowno = 0;
2756     foreach ($export as $row) {
2757         $colno = 0;
2758         foreach($row as $col) {
2759             $worksheet[0]->write($rowno, $colno, $col);
2760             $colno++;
2761         }
2762         $rowno++;
2763     }
2764     $workbook->close();
2765     return $filename;
2766 }
2767
2768 /**
2769  * @global object
2770  * @param array $export
2771  * @param string $dataname
2772  * @param int $count
2773  * @param string
2774  */
2775 function data_export_ods($export, $dataname, $count) {
2776     global $CFG;
2777     require_once("$CFG->libdir/odslib.class.php");
2778     $filename = clean_filename("{$dataname}-{$count}_record");
2779     if ($count > 1) {
2780         $filename .= 's';
2781     }
2782     $filename .= clean_filename('-' . gmdate("Ymd_Hi"));
2783     $filename .= '.ods';
2784     $filearg = '-';
2785     $workbook = new MoodleODSWorkbook($filearg);
2786     $workbook->send($filename);
2787     $worksheet = array();
2788     $worksheet[0] =& $workbook->add_worksheet('');
2789     $rowno = 0;
2790     foreach ($export as $row) {
2791         $colno = 0;
2792         foreach($row as $col) {
2793             $worksheet[0]->write($rowno, $colno, $col);
2794             $colno++;
2795         }
2796         $rowno++;
2797     }
2798     $workbook->close();
2799     return $filename;
2800 }
2801
2802 /**
2803  * @global object
2804  * @param int $dataid
2805  * @param array $fields
2806  * @param array $selectedfields
2807  * @return array
2808  */
2809 function data_get_exportdata($dataid, $fields, $selectedfields) {
2810     global $DB;
2811
2812     $exportdata = array();
2813
2814     // populate the header in first row of export
2815     foreach($fields as $key => $field) {
2816         if (!in_array($field->field->id, $selectedfields)) {
2817             // ignore values we aren't exporting
2818             unset($fields[$key]);
2819         } else {
2820             $exportdata[0][] = $field->field->name;
2821         }
2822     }
2823
2824     $datarecords = $DB->get_records('data_records', array('dataid'=>$dataid));
2825     ksort($datarecords);
2826     $line = 1;
2827     foreach($datarecords as $record) {
2828         // get content indexed by fieldid
2829         if( $content = $DB->get_records('data_content', array('recordid'=>$record->id), 'fieldid', 'fieldid, content, content1, content2, content3, content4') ) {
2830             foreach($fields as $field) {
2831                 $contents = '';
2832                 if(isset($content[$field->field->id])) {
2833                     $contents = $field->export_text_value($content[$field->field->id]);
2834                 }
2835                 $exportdata[$line][] = $contents;
2836             }
2837         }
2838         $line++;
2839     }
2840     $line--;
2841     return $exportdata;
2842 }
2843
2844 /**
2845  * Lists all browsable file areas
2846  *
2847  * @param object $course
2848  * @param object $cm
2849  * @param object $context
2850  * @return array
2851  */
2852 function data_get_file_areas($course, $cm, $context) {
2853     $areas = array();
2854     return $areas;
2855 }
2856
2857 /**
2858  * Serves the data attachments. Implements needed access control ;-)
2859  *
2860  * @param object $course
2861  * @param object $cm
2862  * @param object $context
2863  * @param string $filearea
2864  * @param array $args
2865  * @param bool $forcedownload
2866  * @return bool false if file not found, does not return if found - justsend the file
2867  */
2868 function data_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
2869     global $CFG, $DB;
2870
2871     if ($context->contextlevel != CONTEXT_MODULE) {
2872         return false;
2873     }
2874
2875     require_course_login($course, true, $cm);
2876
2877     if ($filearea === 'content') {
2878         $contentid = (int)array_shift($args);
2879
2880         if (!$content = $DB->get_record('data_content', array('id'=>$contentid))) {
2881             return false;
2882         }
2883
2884         if (!$field = $DB->get_record('data_fields', array('id'=>$content->fieldid))) {
2885             return false;
2886         }
2887
2888         if (!$record = $DB->get_record('data_records', array('id'=>$content->recordid))) {
2889             return false;
2890         }
2891
2892         if (!$data = $DB->get_record('data', array('id'=>$field->dataid))) {
2893             return false;
2894         }
2895
2896         if ($data->id != $cm->instance) {
2897             // hacker attempt - context does not match the contentid
2898             return false;
2899         }
2900
2901         //check if approved
2902         if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
2903             return false;
2904         }
2905
2906         // group access
2907         if ($record->groupid) {
2908             $groupmode = groups_get_activity_groupmode($cm, $course);
2909             if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2910                 if (!groups_is_member($record->groupid)) {
2911                     return false;
2912                 }
2913             }
2914         }
2915
2916         $fieldobj = data_get_field($field, $data, $cm);
2917
2918         $relativepath = implode('/', $args);
2919         $fullpath = "/$context->id/mod_data/content/$content->id/$relativepath";
2920
2921         if (!$fieldobj->file_ok($relativepath)) {
2922             return false;
2923         }
2924
2925         $fs = get_file_storage();
2926         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2927             return false;
2928         }
2929
2930         // finally send the file
2931         send_stored_file($file, 0, 0, true); // download MUST be forced - security!
2932     }
2933
2934     return false;
2935 }
2936
2937
2938 function data_extend_navigation($navigation, $course, $module, $cm) {
2939     global $CFG, $OUTPUT, $USER, $DB;
2940
2941     $rid = optional_param('rid', 0, PARAM_INT);
2942
2943     $data = $DB->get_record('data', array('id'=>$cm->instance));
2944     $currentgroup = groups_get_activity_group($cm);
2945     $groupmode = groups_get_activity_groupmode($cm);
2946
2947      $numentries = data_numentries($data);
2948     /// Check the number of entries required against the number of entries already made (doesn't apply to teachers)
2949     if ($data->requiredentries > 0 && $numentries < $data->requiredentries && !has_capability('mod/data:manageentries', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2950         $data->entriesleft = $data->requiredentries - $numentries;
2951         $entriesnode = $navigation->add(get_string('entrieslefttoadd', 'data', $data));
2952         $entriesnode->add_class('note');
2953     }
2954
2955     $navigation->add(get_string('list', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance)));
2956     if (!empty($rid)) {
2957         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'rid'=>$rid)));
2958     } else {
2959         $navigation->add(get_string('single', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'single')));
2960     }
2961     $navigation->add(get_string('search', 'data'), new moodle_url('/mod/data/view.php', array('d'=>$cm->instance, 'mode'=>'asearch')));
2962 }
2963
2964 /**
2965  * Adds module specific settings to the settings block
2966  *
2967  * @param settings_navigation $settings The settings navigation object
2968  * @param navigation_node $datanode The node to add module settings to
2969  */
2970 function data_extend_settings_navigation(settings_navigation $settings, navigation_node $datanode) {
2971     global $PAGE, $DB, $CFG, $USER;
2972
2973     $data = $DB->get_record('data', array("id" => $PAGE->cm->instance));
2974
2975     $currentgroup = groups_get_activity_group($PAGE->cm);
2976     $groupmode = groups_get_activity_groupmode($PAGE->cm);
2977
2978     if (data_user_can_add_entry($data, $currentgroup, $groupmode, $PAGE->cm->context)) { // took out participation list here!
2979         if (empty($editentry)) { //TODO: undefined
2980             $addstring = get_string('add', 'data');
2981         } else {
2982             $addstring = get_string('editentry', 'data');
2983         }
2984         $datanode->add($addstring, new moodle_url('/mod/data/edit.php', array('d'=>$PAGE->cm->instance)));
2985     }
2986
2987     if (has_capability(DATA_CAP_EXPORT, $PAGE->cm->context)) {
2988         // The capability required to Export database records is centrally defined in 'lib.php'
2989         // and should be weaker than those required to edit Templates, Fields and Presets.
2990         $datanode->add(get_string('exportentries', 'data'), new moodle_url('/mod/data/export.php', array('d'=>$data->id)));
2991     }
2992     if (has_capability('mod/data:manageentries', $PAGE->cm->context)) {
2993         $datanode->add(get_string('importentries', 'data'), new moodle_url('/mod/data/import.php', array('d'=>$data->id)));
2994     }
2995
2996     if (has_capability('mod/data:managetemplates', $PAGE->cm->context)) {
2997         $currenttab = '';
2998         if ($currenttab == 'list') {
2999             $defaultemplate = 'listtemplate';
3000         } else if ($currenttab == 'add') {
3001             $defaultemplate = 'addtemplate';
3002         } else if ($currenttab == 'asearch') {
3003             $defaultemplate = 'asearchtemplate';
3004         } else {
3005             $defaultemplate = 'singletemplate';
3006         }
3007
3008         $templates = $datanode->add(get_string('templates', 'data'));
3009
3010         $templatelist = array ('listtemplate', 'singletemplate', 'asearchtemplate', 'addtemplate', 'rsstemplate', 'csstemplate', 'jstemplate');
3011         foreach ($templatelist as $template) {
3012             $templates->add(get_string($template, 'data'), new moodle_url('/mod/data/templates.php', array('d'=>$data->id,'mode'=>$template)));
3013         }
3014
3015         $datanode->add(get_string('fields', 'data'), new moodle_url('/mod/data/field.php', array('d'=>$data->id)));
3016         $datanode->add(get_string('presets', 'data'), new moodle_url('/mod/data/preset.php', array('d'=>$data->id)));
3017     }
3018
3019     if (!empty($CFG->enablerssfeeds) && !empty($CFG->data_enablerssfeeds) && $data->rssarticles > 0) {
3020         require_once("$CFG->libdir/rsslib.php");
3021
3022         $string = get_string('rsstype','forum');
3023
3024         $url = new moodle_url(rss_get_url($PAGE->cm->context->id, $USER->id, 'mod_data', $data->id));
3025         $datanode->add($string, $url, settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
3026     }
3027 }
3028
3029 /**
3030  * Save the database configuration as a preset.
3031  *
3032  * @param stdClass $course The course the database module belongs to.
3033  * @param stdClass $cm The course module record
3034  * @param stdClass $data The database record
3035  * @param string $path
3036  * @return bool
3037  */
3038 function data_presets_save($course, $cm, $data, $path) {
3039     $fs = get_file_storage();
3040     $filerecord = new stdClass;
3041     $filerecord->contextid = DATA_PRESET_CONTEXT;
3042     $filerecord->component = DATA_PRESET_COMPONENT;
3043     $filerecord->filearea = DATA_PRESET_FILEAREA;
3044     $filerecord->itemid = 0;
3045     $filerecord->filepath = '/'.$path.'/';
3046
3047     $filerecord->filename = 'preset.xml';
3048     $fs->create_file_from_string($filerecord, data_presets_generate_xml($course, $cm, $data));
3049
3050     $filerecord->filename = 'singletemplate.html';
3051     $fs->create_file_from_string($filerecord, $data->singletemplate);
3052
3053     $filerecord->filename = 'listtemplateheader.html';
3054     $fs->create_file_from_string($filerecord, $data->listtemplateheader);
3055
3056     $filerecord->filename = 'listtemplate.html';
3057     $fs->create_file_from_string($filerecord, $data->listtemplate);
3058
3059     $filerecord->filename = 'listtemplatefooter.html';
3060     $fs->create_file_from_string($filerecord, $data->listtemplatefooter);
3061
3062     $filerecord->filename = 'addtemplate.html';
3063     $fs->create_file_from_string($filerecord, $data->addtemplate);
3064
3065     $filerecord->filename = 'rsstemplate.html';
3066     $fs->create_file_from_string($filerecord, $data->rsstemplate);
3067
3068     $filerecord->filename = 'rsstitletemplate.html';
3069     $fs->create_file_from_string($filerecord, $data->rsstitletemplate);
3070
3071     $filerecord->filename = 'csstemplate.css';
3072     $fs->create_file_from_string($filerecord, $data->csstemplate);
3073
3074     $filerecord->filename = 'jstemplate.js';
3075     $fs->create_file_from_string($filerecord, $data->jstemplate);
3076
3077     $filerecord->filename = 'asearchtemplate.html';
3078     $fs->create_file_from_string($filerecord, $data->asearchtemplate);
3079
3080     return true;
3081 }
3082
3083 /**
3084  * Generates the XML for the database module provided
3085  *
3086  * @global moodle_database $DB
3087  * @param stdClass $course The course the database module belongs to.
3088  * @param stdClass $cm The course module record
3089  * @param stdClass $data The database record
3090  * @return string The XML for the preset
3091  */
3092 function data_presets_generate_xml($course, $cm, $data) {
3093     global $DB;
3094
3095     // Assemble "preset.xml":
3096     $presetxmldata = "<preset>\n\n";
3097
3098     // Raw settings are not preprocessed during saving of presets
3099     $raw_settings = array(
3100         'intro',
3101         'comments',
3102         'requiredentries',
3103         'requiredentriestoview',
3104         'maxentries',
3105         'rssarticles',
3106         'approval',
3107         'defaultsortdir'
3108     );
3109
3110     $presetxmldata .= "<settings>\n";
3111     // First, settings that do not require any conversion
3112     foreach ($raw_settings as $setting) {
3113         $presetxmldata .= "<$setting>" . htmlspecialchars($data->$setting) . "</$setting>\n";
3114     }
3115
3116     // Now specific settings
3117     if ($data->defaultsort > 0 && $sortfield = data_get_field_from_id($data->defaultsort, $data)) {
3118         $presetxmldata .= '<defaultsort>' . htmlspecialchars($sortfield->field->name) . "</defaultsort>\n";
3119     } else {
3120         $presetxmldata .= "<defaultsort>0</defaultsort>\n";
3121     }
3122     $presetxmldata .= "</settings>\n\n";
3123     // Now for the fields. Grab all that are non-empty
3124     $fields = $DB->get_records('data_fields', array('dataid'=>$data->id));
3125     ksort($fields);
3126     if (!empty($fields)) {
3127         foreach ($fields as $field) {
3128             $presetxmldata .= "<field>\n";
3129             foreach ($field as $key => $value) {
3130                 if ($value != '' && $key != 'id' && $key != 'dataid') {
3131                     $presetxmldata .= "<$key>" . htmlspecialchars($value) . "</$key>\n";
3132                 }
3133             }
3134             $presetxmldata .= "</field>\n\n";
3135         }
3136     }
3137     $presetxmldata .= '</preset>';
3138     return $presetxmldata;
3139 }
3140
3141 function data_presets_export($course, $cm, $data, $tostorage=false) {
3142     global $CFG, $DB;
3143
3144     $presetname = clean_filename($data->name) . '-preset-' . gmdate("Ymd_Hi");
3145     $exportsubdir = "mod_data/presetexport/$presetname";
3146     make_temp_directory($exportsubdir);
3147     $exportdir = "$CFG->tempdir/$exportsubdir";
3148
3149     // Assemble "preset.xml":
3150     $presetxmldata = data_presets_generate_xml($course, $cm, $data);
3151
3152     // After opening a file in write mode, close it asap
3153     $presetxmlfile = fopen($exportdir . '/preset.xml', 'w');
3154     fwrite($presetxmlfile, $presetxmldata);
3155     fclose($presetxmlfile);
3156
3157     // Now write the template files
3158     $singletemplate = fopen($exportdir . '/singletemplate.html', 'w');
3159     fwrite($singletemplate, $data->singletemplate);
3160     fclose($singletemplate);
3161
3162     $listtemplateheader = fopen($exportdir . '/listtemplateheader.html', 'w');
3163     fwrite($listtemplateheader, $data->listtemplateheader);
3164     fclose($listtemplateheader);
3165
3166     $listtemplate = fopen($exportdir . '/listtemplate.html', 'w');
3167     fwrite($listtemplate, $data->listtemplate);
3168     fclose($listtemplate);
3169
3170     $listtemplatefooter = fopen($exportdir . '/listtemplatefooter.html', 'w');
3171     fwrite($listtemplatefooter, $data->listtemplatefooter);
3172     fclose($listtemplatefooter);
3173
3174     $addtemplate = fopen($exportdir . '/addtemplate.html', 'w');
3175     fwrite($addtemplate, $data->addtemplate);
3176     fclose($addtemplate);
3177
3178     $rsstemplate = fopen($exportdir . '/rsstemplate.html', 'w');
3179     fwrite($rsstemplate, $data->rsstemplate);
3180     fclose($rsstemplate);
3181
3182     $rsstitletemplate = fopen($exportdir . '/rsstitletemplate.html', 'w');
3183     fwrite($rsstitletemplate, $data->rsstitletemplate);
3184     fclose($rsstitletemplate);
3185
3186     $csstemplate = fopen($exportdir . '/csstemplate.css', 'w');
3187     fwrite($csstemplate, $data->csstemplate);
3188     fclose($csstemplate);
3189
3190     $jstemplate = fopen($exportdir . '/jstemplate.js', 'w');
3191     fwrite($jstemplate, $data->jstemplate);
3192     fclose($jstemplate);
3193
3194     $asearchtemplate = fopen($exportdir . '/asearchtemplate.html', 'w');
3195     fwrite($asearchtemplate, $data->asearchtemplate);
3196     fclose($asearchtemplate);
3197
3198     // Check if all files have been generated
3199     if (! is_directory_a_preset($exportdir)) {
3200         print_error('generateerror', 'data');
3201     }
3202
3203     $filenames = array(
3204         'preset.xml',
3205         'singletemplate.html',
3206         'listtemplateheader.html',
3207         'listtemplate.html',
3208         'listtemplatefooter.html',
3209         'addtemplate.html',
3210         'rsstemplate.html',
3211         'rsstitletemplate.html',
3212         'csstemplate.css',
3213         'jstemplate.js',
3214         'asearchtemplate.html'
3215     );
3216
3217     $filelist = array();
3218     foreach ($filenames as $filename) {
3219         $filelist[$filename] = $exportdir . '/' . $filename;
3220     }
3221
3222     $exportfile = $exportdir.'.zip';
3223     file_exists($exportfile) && unlink($exportfile);
3224
3225     $fp = get_file_packer('application/zip');
3226     $fp->archive_to_pathname($filelist, $exportfile);
3227
3228     foreach ($filelist as $file) {
3229         unlink($file);
3230     }
3231     rmdir($exportdir);
3232
3233     // Return the full path to the exported preset file:
3234     return $exportfile;
3235 }
3236
3237 /**
3238  * Running addtional permission check on plugin, for example, plugins
3239  * may have switch to turn on/off comments option, this callback will
3240  * affect UI display, not like pluginname_comment_validate only throw
3241  * exceptions.
3242  * Capability check has been done in comment->check_permissions(), we
3243  * don't need to do it again here.
3244  *
3245  * @param stdClass $comment_param {
3246  *              context  => context the context object
3247  *              courseid => int course id
3248  *              cm       => stdClass course module object
3249  *              commentarea => string comment area
3250  *              itemid      => int itemid
3251  * }
3252  * @return array
3253  */
3254 function data_comment_permissions($comment_param) {
3255     global $CFG, $DB;
3256     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3257         throw new comment_exception('invalidcommentitemid');
3258     }
3259     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3260         throw new comment_exception('invalidid', 'data');
3261     }
3262     if ($data->comments) {
3263         return array('post'=>true, 'view'=>true);
3264     } else {
3265         return array('post'=>false, 'view'=>false);
3266     }
3267 }
3268
3269 /**
3270  * Validate comment parameter before perform other comments actions
3271  *
3272  * @param stdClass $comment_param {
3273  *              context  => context the context object
3274  *              courseid => int course id
3275  *              cm       => stdClass course module object
3276  *              commentarea => string comment area
3277  *              itemid      => int itemid
3278  * }
3279  * @return boolean
3280  */
3281 function data_comment_validate($comment_param) {
3282     global $DB;
3283     // validate comment area
3284     if ($comment_param->commentarea != 'database_entry') {
3285         throw new comment_exception('invalidcommentarea');
3286     }
3287     // validate itemid
3288     if (!$record = $DB->get_record('data_records', array('id'=>$comment_param->itemid))) {
3289         throw new comment_exception('invalidcommentitemid');
3290     }
3291     if (!$data = $DB->get_record('data', array('id'=>$record->dataid))) {
3292         throw new comment_exception('invalidid', 'data');
3293     }
3294     if (!$course = $DB->get_record('course', array('id'=>$data->course))) {
3295         throw new comment_exception('coursemisconf');
3296     }
3297     if (!$cm = get_coursemodule_from_instance('data', $data->id, $course->id)) {
3298         throw new comment_exception('invalidcoursemodule');
3299     }
3300     if (!$data->comments) {
3301         throw new comment_exception('commentsoff', 'data');
3302     }
3303     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
3304
3305     //check if approved
3306     if ($data->approval and !$record->approved and !data_isowner($record) and !has_capability('mod/data:approve', $context)) {
3307         throw new comment_exception('notapproved', 'data');
3308     }
3309
3310     // group access
3311     if ($record->groupid) {
3312         $groupmode = groups_get_activity_groupmode($cm, $course);
3313         if ($groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
3314             if (!groups_is_member($record->groupid)) {
3315                 throw new comment_exception('notmemberofgroup');
3316             }
3317         }
3318     }
3319     // validate context id
3320     if ($context->id != $comment_param->context->id) {
3321         throw new comment_exception('invalidcontext');
3322     }
3323     // validation for comment deletion
3324     if (!empty($comment_param->commentid)) {
3325         if ($comment = $DB->get_record('comments', array('id'=>$comment_param->commentid))) {
3326             if ($comment->commentarea != 'database_entry') {
3327                 throw new comment_exception('invalidcommentarea');
3328             }
3329             if ($comment->contextid != $comment_param->context->id) {
3330                 throw new comment_exception('invalidcontext');
3331             }
3332             if ($comment->itemid != $comment_param->itemid) {
3333                 throw new comment_exception('invalidcommentitemid');
3334             }
3335         } else {
3336             throw new comment_exception('invalidcommentid');
3337         }
3338     }
3339     return true;
3340 }
3341
3342 /**
3343  * Return a list of page types
3344  * @param string $pagetype current page type
3345  * @param stdClass $parentcontext Block's parent context
3346  * @param stdClass $currentcontext Current context of block
3347  */
3348 function data_page_type_list($pagetype, $parentcontext, $currentcontext) {
3349     $module_pagetype = array('mod-data-*'=>get_string('page-mod-data-x', 'data'));
3350     return $module_pagetype;
3351 }