1ce68e8fe5e8a70b1e7d39509aec26cc5dc9ecea
[moodle.git] / question / type / calculated / questiontype.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Question type class for the calculated question type.
19  *
20  * @package    qtype
21  * @subpackage calculated
22  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/question/type/questionbase.php');
30 require_once($CFG->dirroot . '/question/type/numerical/question.php');
33 /**
34  * The calculated question type.
35  *
36  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class qtype_calculated extends question_type {
40     /** Regular expression that finds the formulas in content. */
41     const FORMULAS_IN_TEXT_REGEX = '~\{=([^{}]*(?:\{[^{}]+}[^{}]*)*)\}~';
43     const MAX_DATASET_ITEMS = 100;
45     public $wizardpagesnumber = 3;
47     public function get_question_options($question) {
48         // First get the datasets and default options.
49         // The code is used for calculated, calculatedsimple and calculatedmulti qtypes.
50         global $CFG, $DB, $OUTPUT;
51         if (!$question->options = $DB->get_record('question_calculated_options',
52                 array('question' => $question->id))) {
53             $question->options = new stdClass();
54             $question->options->synchronize = 0;
55             $question->options->single = 0;
56             $question->options->answernumbering = 'abc';
57             $question->options->shuffleanswers = 0;
58             $question->options->correctfeedback = '';
59             $question->options->partiallycorrectfeedback = '';
60             $question->options->incorrectfeedback = '';
61             $question->options->correctfeedbackformat = 0;
62             $question->options->partiallycorrectfeedbackformat = 0;
63             $question->options->incorrectfeedbackformat = 0;
64         }
66         if (!$question->options->answers = $DB->get_records_sql("
67             SELECT a.*, c.tolerance, c.tolerancetype, c.correctanswerlength, c.correctanswerformat
68             FROM {question_answers} a,
69                  {question_calculated} c
70             WHERE a.question = ?
71             AND   a.id = c.answer
72             ORDER BY a.id ASC", array($question->id))) {
73                 return false;
74         }
76         if ($this->get_virtual_qtype()->name() == 'numerical') {
77             $this->get_virtual_qtype()->get_numerical_units($question);
78             $this->get_virtual_qtype()->get_numerical_options($question);
79         }
81         $question->hints = $DB->get_records('question_hints',
82                 array('questionid' => $question->id), 'id ASC');
84         if (isset($question->export_process)&&$question->export_process) {
85             $question->options->datasets = $this->get_datasets_for_export($question);
86         }
87         return true;
88     }
90     public function get_datasets_for_export($question) {
91         global $DB, $CFG;
92         $datasetdefs = array();
93         if (!empty($question->id)) {
94             $sql = "SELECT i.*
95                       FROM {question_datasets} d, {question_dataset_definitions} i
96                      WHERE d.question = ? AND d.datasetdefinition = i.id";
97             if ($records = $DB->get_records_sql($sql, array($question->id))) {
98                 foreach ($records as $r) {
99                     $def = $r;
100                     if ($def->category == '0') {
101                         $def->status = 'private';
102                     } else {
103                         $def->status = 'shared';
104                     }
105                     $def->type = 'calculated';
106                     list($distribution, $min, $max, $dec) = explode(':', $def->options, 4);
107                     $def->distribution = $distribution;
108                     $def->minimum = $min;
109                     $def->maximum = $max;
110                     $def->decimals = $dec;
111                     if ($def->itemcount > 0) {
112                         // Get the datasetitems.
113                         $def->items = array();
114                         if ($items = $this->get_database_dataset_items($def->id)) {
115                             $n = 0;
116                             foreach ($items as $ii) {
117                                 $n++;
118                                 $def->items[$n] = new stdClass();
119                                 $def->items[$n]->itemnumber = $ii->itemnumber;
120                                 $def->items[$n]->value = $ii->value;
121                             }
122                             $def->number_of_items = $n;
123                         }
124                     }
125                     $datasetdefs["1-$r->category-$r->name"] = $def;
126                 }
127             }
128         }
129         return $datasetdefs;
130     }
132     public function save_question_options($question) {
133         global $CFG, $DB;
134         // The code is used for calculated, calculatedsimple and calculatedmulti qtypes.
135         $context = $question->context;
136         if (isset($question->answer) && !isset($question->answers)) {
137             $question->answers = $question->answer;
138         }
139         // Calculated options.
140         $update = true;
141         $options = $DB->get_record('question_calculated_options',
142                 array('question' => $question->id));
143         if (!$options) {
144             $update = false;
145             $options = new stdClass();
146             $options->question = $question->id;
147         }
148         // As used only by calculated.
149         if (isset($question->synchronize)) {
150             $options->synchronize = $question->synchronize;
151         } else {
152             $options->synchronize = 0;
153         }
154         $options->single = 0;
155         $options->answernumbering =  $question->answernumbering;
156         $options->shuffleanswers = $question->shuffleanswers;
158         foreach (array('correctfeedback', 'partiallycorrectfeedback',
159                 'incorrectfeedback') as $feedbackname) {
160             $options->$feedbackname = '';
161             $feedbackformat = $feedbackname . 'format';
162             $options->$feedbackformat = 0;
163         }
165         if ($update) {
166             $DB->update_record('question_calculated_options', $options);
167         } else {
168             $DB->insert_record('question_calculated_options', $options);
169         }
171         // Get old versions of the objects.
172         $oldanswers = $DB->get_records('question_answers',
173                 array('question' => $question->id), 'id ASC');
175         $oldoptions = $DB->get_records('question_calculated',
176                 array('question' => $question->id), 'answer ASC');
178         // Save the units.
179         $virtualqtype = $this->get_virtual_qtype();
181         $result = $virtualqtype->save_units($question);
182         if (isset($result->error)) {
183             return $result;
184         } else {
185             $units = $result->units;
186         }
188         // Insert all the new answers.
189         if (isset($question->answer) && !isset($question->answers)) {
190             $question->answers = $question->answer;
191         }
192         foreach ($question->answers as $key => $answerdata) {
193             if (is_array($answerdata)) {
194                 $answerdata = $answerdata['text'];
195             }
196             if (trim($answerdata) == '') {
197                 continue;
198             }
200             // Update an existing answer if possible.
201             $answer = array_shift($oldanswers);
202             if (!$answer) {
203                 $answer = new stdClass();
204                 $answer->question = $question->id;
205                 $answer->answer   = '';
206                 $answer->feedback = '';
207                 $answer->id       = $DB->insert_record('question_answers', $answer);
208             }
210             $answer->answer   = trim($answerdata);
211             $answer->fraction = $question->fraction[$key];
212             $answer->feedback = $this->import_or_save_files($question->feedback[$key],
213                     $context, 'question', 'answerfeedback', $answer->id);
214             $answer->feedbackformat = $question->feedback[$key]['format'];
216             $DB->update_record("question_answers", $answer);
218             // Set up the options object.
219             if (!$options = array_shift($oldoptions)) {
220                 $options = new stdClass();
221             }
222             $options->question            = $question->id;
223             $options->answer              = $answer->id;
224             $options->tolerance           = trim($question->tolerance[$key]);
225             $options->tolerancetype       = trim($question->tolerancetype[$key]);
226             $options->correctanswerlength = trim($question->correctanswerlength[$key]);
227             $options->correctanswerformat = trim($question->correctanswerformat[$key]);
229             // Save options.
230             if (isset($options->id)) {
231                 // Reusing existing record.
232                 $DB->update_record('question_calculated', $options);
233             } else {
234                 // New options.
235                 $DB->insert_record('question_calculated', $options);
236             }
237         }
239         // Delete old answer records.
240         if (!empty($oldanswers)) {
241             foreach ($oldanswers as $oa) {
242                 $DB->delete_records('question_answers', array('id' => $oa->id));
243             }
244         }
246         // Delete old answer records.
247         if (!empty($oldoptions)) {
248             foreach ($oldoptions as $oo) {
249                 $DB->delete_records('question_calculated', array('id' => $oo->id));
250             }
251         }
253         $result = $virtualqtype->save_unit_options($question);
254         if (isset($result->error)) {
255             return $result;
256         }
258         $this->save_hints($question);
260         if (isset($question->import_process)&&$question->import_process) {
261             $this->import_datasets($question);
262         }
263         // Report any problems.
264         if (!empty($result->notice)) {
265             return $result;
266         }
267         return true;
268     }
270     public function import_datasets($question) {
271         global $DB;
272         $n = count($question->dataset);
273         foreach ($question->dataset as $dataset) {
274             // Name, type, option.
275             $datasetdef = new stdClass();
276             $datasetdef->name = $dataset->name;
277             $datasetdef->type = 1;
278             $datasetdef->options =  $dataset->distribution . ':' . $dataset->min . ':' .
279                     $dataset->max . ':' . $dataset->length;
280             $datasetdef->itemcount = $dataset->itemcount;
281             if ($dataset->status == 'private') {
282                 $datasetdef->category = 0;
283                 $todo = 'create';
284             } else if ($dataset->status == 'shared') {
285                 if ($sharedatasetdefs = $DB->get_records_select(
286                     'question_dataset_definitions',
287                     "type = '1'
288                     AND name = ?
289                     AND category = ?
290                     ORDER BY id DESC ", array($dataset->name, $question->category)
291                 )) { // So there is at least one.
292                     $sharedatasetdef = array_shift($sharedatasetdefs);
293                     if ($sharedatasetdef->options ==  $datasetdef->options) {// Identical so use it.
294                         $todo = 'useit';
295                         $datasetdef = $sharedatasetdef;
296                     } else { // Different so create a private one.
297                         $datasetdef->category = 0;
298                         $todo = 'create';
299                     }
300                 } else { // No so create one.
301                     $datasetdef->category = $question->category;
302                     $todo = 'create';
303                 }
304             }
305             if ($todo == 'create') {
306                 $datasetdef->id = $DB->insert_record('question_dataset_definitions', $datasetdef);
307             }
308             // Create relation to the dataset.
309             $questiondataset = new stdClass();
310             $questiondataset->question = $question->id;
311             $questiondataset->datasetdefinition = $datasetdef->id;
312             $DB->insert_record('question_datasets', $questiondataset);
313             if ($todo == 'create') {
314                 // Add the items.
315                 foreach ($dataset->datasetitem as $dataitem) {
316                     $datasetitem = new stdClass();
317                     $datasetitem->definition = $datasetdef->id;
318                     $datasetitem->itemnumber = $dataitem->itemnumber;
319                     $datasetitem->value = $dataitem->value;
320                     $DB->insert_record('question_dataset_items', $datasetitem);
321                 }
322             }
323         }
324     }
326     protected function initialise_question_instance(question_definition $question, $questiondata) {
327         parent::initialise_question_instance($question, $questiondata);
329         question_bank::get_qtype('numerical')->initialise_numerical_answers(
330                 $question, $questiondata);
331         foreach ($questiondata->options->answers as $a) {
332             $question->answers[$a->id]->tolerancetype = $a->tolerancetype;
333             $question->answers[$a->id]->correctanswerlength = $a->correctanswerlength;
334             $question->answers[$a->id]->correctanswerformat = $a->correctanswerformat;
335         }
337         $question->synchronised = $questiondata->options->synchronize;
339         $question->unitdisplay = $questiondata->options->showunits;
340         $question->unitgradingtype = $questiondata->options->unitgradingtype;
341         $question->unitpenalty = $questiondata->options->unitpenalty;
342         $question->ap = question_bank::get_qtype(
343                 'numerical')->make_answer_processor(
344                 $questiondata->options->units, $questiondata->options->unitsleft);
346         $question->datasetloader = new qtype_calculated_dataset_loader($questiondata->id);
347     }
349     public function validate_form($form) {
350         switch($form->wizardpage) {
351             case 'question':
352                 $calculatedmessages = array();
353                 if (empty($form->name)) {
354                     $calculatedmessages[] = get_string('missingname', 'qtype_calculated');
355                 }
356                 if (empty($form->questiontext)) {
357                     $calculatedmessages[] = get_string('missingquestiontext', 'qtype_calculated');
358                 }
359                 // Verify formulas.
360                 foreach ($form->answers as $key => $answer) {
361                     if ('' === trim($answer)) {
362                         $calculatedmessages[] = get_string(
363                                 'missingformula', 'qtype_calculated');
364                     }
365                     if ($formulaerrors = qtype_calculated_find_formula_errors($answer)) {
366                         $calculatedmessages[] = $formulaerrors;
367                     }
368                     if (! isset($form->tolerance[$key])) {
369                         $form->tolerance[$key] = 0.0;
370                     }
371                     if (! is_numeric($form->tolerance[$key])) {
372                         $calculatedmessages[] = get_string('xmustbenumeric', 'qtype_numerical',
373                                 get_string('tolerance', 'qtype_calculated'));
374                     }
375                 }
377                 if (!empty($calculatedmessages)) {
378                     $errorstring = "The following errors were found:<br />";
379                     foreach ($calculatedmessages as $msg) {
380                         $errorstring .= $msg . '<br />';
381                     }
382                     print_error($errorstring);
383                 }
385                 break;
386             default:
387                 return parent::validate_form($form);
388                 break;
389         }
390         return true;
391     }
392     public function finished_edit_wizard($form) {
393         return isset($form->savechanges);
394     }
395     public function wizardpagesnumber() {
396         return 3;
397     }
398     // This gets called by editquestion.php after the standard question is saved.
399     public function print_next_wizard_page($question, $form, $course) {
400         global $CFG, $SESSION, $COURSE;
402         // Catch invalid navigation & reloads.
403         if (empty($question->id) && empty($SESSION->calculated)) {
404             redirect('edit.php?courseid='.$COURSE->id, 'The page you are loading has expired.', 3);
405         }
407         // See where we're coming from.
408         switch($form->wizardpage) {
409             case 'question':
410                 require("$CFG->dirroot/question/type/calculated/datasetdefinitions.php");
411                 break;
412             case 'datasetdefinitions':
413             case 'datasetitems':
414                 require("$CFG->dirroot/question/type/calculated/datasetitems.php");
415                 break;
416             default:
417                 print_error('invalidwizardpage', 'question');
418                 break;
419         }
420     }
422     // This gets called by question2.php after the standard question is saved.
423     public function &next_wizard_form($submiturl, $question, $wizardnow) {
424         global $CFG, $SESSION, $COURSE;
426         // Catch invalid navigation & reloads.
427         if (empty($question->id) && empty($SESSION->calculated)) {
428             redirect('edit.php?courseid=' . $COURSE->id,
429                     'The page you are loading has expired. Cannot get next wizard form.', 3);
430         }
431         if (empty($question->id)) {
432             $question = $SESSION->calculated->questionform;
433         }
435         // See where we're coming from.
436         switch($wizardnow) {
437             case 'datasetdefinitions':
438                 require("$CFG->dirroot/question/type/calculated/datasetdefinitions_form.php");
439                 $mform = new question_dataset_dependent_definitions_form(
440                         "$submiturl?wizardnow=datasetdefinitions", $question);
441                 break;
442             case 'datasetitems':
443                 require("$CFG->dirroot/question/type/calculated/datasetitems_form.php");
444                 $regenerate = optional_param('forceregeneration', false, PARAM_BOOL);
445                 $mform = new question_dataset_dependent_items_form(
446                         "$submiturl?wizardnow=datasetitems", $question, $regenerate);
447                 break;
448             default:
449                 print_error('invalidwizardpage', 'question');
450                 break;
451         }
453         return $mform;
454     }
456     /**
457      * This method should be overriden if you want to include a special heading or some other
458      * html on a question editing page besides the question editing form.
459      *
460      * @param question_edit_form $mform a child of question_edit_form
461      * @param object $question
462      * @param string $wizardnow is '' for first page.
463      */
464     public function display_question_editing_page($mform, $question, $wizardnow) {
465         global $OUTPUT;
466         switch ($wizardnow) {
467             case '':
468                 // On the first page, the default display is fine.
469                 parent::display_question_editing_page($mform, $question, $wizardnow);
470                 return;
472             case 'datasetdefinitions':
473                 echo $OUTPUT->heading_with_help(
474                         get_string('choosedatasetproperties', 'qtype_calculated'),
475                         'questiondatasets', 'qtype_calculated');
476                 break;
478             case 'datasetitems':
479                 echo $OUTPUT->heading_with_help(get_string('editdatasets', 'qtype_calculated'),
480                         'questiondatasets', 'qtype_calculated');
481                 break;
482         }
484         $mform->display();
485     }
487     /**
488      * This method prepare the $datasets in a format similar to dadatesetdefinitions_form.php
489      * so that they can be saved
490      * using the function save_dataset_definitions($form)
491      * when creating a new calculated question or
492      * when editing an already existing calculated question
493      * or by  function save_as_new_dataset_definitions($form, $initialid)
494      * when saving as new an already existing calculated question.
495      *
496      * @param object $form
497      * @param int $questionfromid default = '0'
498      */
499     public function preparedatasets($form , $questionfromid = '0') {
500         // The dataset names present in the edit_question_form and edit_calculated_form
501         // are retrieved.
502         $possibledatasets = $this->find_dataset_names($form->questiontext);
503         $mandatorydatasets = array();
504         foreach ($form->answers as $answer) {
505             $mandatorydatasets += $this->find_dataset_names($answer);
506         }
507         // If there are identical datasetdefs already saved in the original question
508         // either when editing a question or saving as new,
509         // they are retrieved using $questionfromid.
510         if ($questionfromid != '0') {
511             $form->id = $questionfromid;
512         }
513         $datasets = array();
514         $key = 0;
515         // Always prepare the mandatorydatasets present in the answers.
516         // The $options are not used here.
517         foreach ($mandatorydatasets as $datasetname) {
518             if (!isset($datasets[$datasetname])) {
519                 list($options, $selected) =
520                     $this->dataset_options($form, $datasetname);
521                 $datasets[$datasetname] = '';
522                 $form->dataset[$key] = $selected;
523                 $key++;
524             }
525         }
526         // Do not prepare possibledatasets when creating a question.
527         // They will defined and stored with datasetdefinitions_form.php.
528         // The $options are not used here.
529         if ($questionfromid != '0') {
531             foreach ($possibledatasets as $datasetname) {
532                 if (!isset($datasets[$datasetname])) {
533                     list($options, $selected) =
534                         $this->dataset_options($form, $datasetname, false);
535                     $datasets[$datasetname] = '';
536                     $form->dataset[$key] = $selected;
537                     $key++;
538                 }
539             }
540         }
541         return $datasets;
542     }
543     public function addnamecategory(&$question) {
544         global $DB;
545         $categorydatasetdefs = $DB->get_records_sql(
546             "SELECT  a.*
547                FROM {question_datasets} b, {question_dataset_definitions} a
548               WHERE a.id = b.datasetdefinition
549                 AND a.type = '1'
550                 AND a.category != 0
551                 AND b.question = ?
552            ORDER BY a.name ", array($question->id));
553         $questionname = $question->name;
554         $regs= array();
555         if (preg_match('~#\{([^[:space:]]*)#~', $questionname , $regs)) {
556             $questionname = str_replace($regs[0], '', $questionname);
557         };
559         if (!empty($categorydatasetdefs)) {
560             // There is at least one with the same name.
561             $questionname = '#' . $questionname;
562             foreach ($categorydatasetdefs as $def) {
563                 if (strlen($def->name) + strlen($questionname) < 250) {
564                     $questionname = '{' . $def->name . '}' . $questionname;
565                 }
566             }
567             $questionname = '#' . $questionname;
568         }
569         $DB->set_field('question', 'name', $questionname, array('id' => $question->id));
570     }
572     /**
573      * this version save the available data at the different steps of the question editing process
574      * without using global $SESSION as storage between steps
575      * at the first step $wizardnow = 'question'
576      *  when creating a new question
577      *  when modifying a question
578      *  when copying as a new question
579      *  the general parameters and answers are saved using parent::save_question
580      *  then the datasets are prepared and saved
581      * at the second step $wizardnow = 'datasetdefinitions'
582      *  the datadefs final type are defined as private, category or not a datadef
583      * at the third step $wizardnow = 'datasetitems'
584      *  the datadefs parameters and the data items are created or defined
585      *
586      * @param object question
587      * @param object $form
588      * @param int $course
589      * @param PARAM_ALPHA $wizardnow should be added as we are coming from question2.php
590      */
591     public function save_question($question, $form) {
592         global $DB;
593         if ($this->wizardpagesnumber() == 1 || $question->qtype == 'calculatedsimple') {
594                 $question = parent::save_question($question, $form);
595             return $question;
596         }
598         $wizardnow =  optional_param('wizardnow', '', PARAM_ALPHA);
599         $id = optional_param('id', 0, PARAM_INT); // Question id.
600         // In case 'question':
601         // For a new question $form->id is empty
602         // when saving as new question.
603         // The $question->id = 0, $form is $data from question2.php
604         // and $data->makecopy is defined as $data->id is the initial question id.
605         // Edit case. If it is a new question we don't necessarily need to
606         // return a valid question object.
608         // See where we're coming from.
609         switch($wizardnow) {
610             case '' :
611             case 'question': // Coming from the first page, creating the second.
612                 if (empty($form->id)) { // or a new question $form->id is empty.
613                     $question = parent::save_question($question, $form);
614                     // Prepare the datasets using default $questionfromid.
615                     $this->preparedatasets($form);
616                     $form->id = $question->id;
617                     $this->save_dataset_definitions($form);
618                     if (isset($form->synchronize) && $form->synchronize == 2) {
619                         $this->addnamecategory($question);
620                     }
621                 } else if (!empty($form->makecopy)) {
622                     $questionfromid =  $form->id;
623                     $question = parent::save_question($question, $form);
624                     // Prepare the datasets.
625                     $this->preparedatasets($form, $questionfromid);
626                     $form->id = $question->id;
627                     $this->save_as_new_dataset_definitions($form, $questionfromid);
628                     if (isset($form->synchronize) && $form->synchronize == 2) {
629                         $this->addnamecategory($question);
630                     }
631                 } else {
632                     // Editing a question.
633                     $question = parent::save_question($question, $form);
634                     // Prepare the datasets.
635                     $this->preparedatasets($form, $question->id);
636                     $form->id = $question->id;
637                     $this->save_dataset_definitions($form);
638                     if (isset($form->synchronize) && $form->synchronize == 2) {
639                         $this->addnamecategory($question);
640                     }
641                 }
642                 break;
643             case 'datasetdefinitions':
644                 // Calculated options.
645                 // It cannot go here without having done the first page,
646                 // so the question_calculated_options should exist.
647                 // We only need to update the synchronize field.
648                 if (isset($form->synchronize)) {
649                     $optionssynchronize = $form->synchronize;
650                 } else {
651                     $optionssynchronize = 0;
652                 }
653                 $DB->set_field('question_calculated_options', 'synchronize', $optionssynchronize,
654                         array('question' => $question->id));
655                 if (isset($form->synchronize) && $form->synchronize == 2) {
656                     $this->addnamecategory($question);
657                 }
659                 $this->save_dataset_definitions($form);
660                 break;
661             case 'datasetitems':
662                 $this->save_dataset_items($question, $form);
663                 $this->save_question_calculated($question, $form);
664                 break;
665             default:
666                 print_error('invalidwizardpage', 'question');
667                 break;
668         }
669         return $question;
670     }
672     public function delete_question($questionid, $contextid) {
673         global $DB;
675         $DB->delete_records('question_calculated', array('question' => $questionid));
676         $DB->delete_records('question_calculated_options', array('question' => $questionid));
677         $DB->delete_records('question_numerical_units', array('question' => $questionid));
678         if ($datasets = $DB->get_records('question_datasets', array('question' => $questionid))) {
679             foreach ($datasets as $dataset) {
680                 if (!$DB->get_records_select('question_datasets',
681                         "question != ? AND datasetdefinition = ? ",
682                         array($questionid, $dataset->datasetdefinition))) {
683                     $DB->delete_records('question_dataset_definitions',
684                             array('id' => $dataset->datasetdefinition));
685                     $DB->delete_records('question_dataset_items',
686                             array('definition' => $dataset->datasetdefinition));
687                 }
688             }
689         }
690         $DB->delete_records('question_datasets', array('question' => $questionid));
692         parent::delete_question($questionid, $contextid);
693     }
695     public function get_random_guess_score($questiondata) {
696         foreach ($questiondata->options->answers as $aid => $answer) {
697             if ('*' == trim($answer->answer)) {
698                 return max($answer->fraction - $questiondata->options->unitpenalty, 0);
699             }
700         }
701         return 0;
702     }
704     public function supports_dataset_item_generation() {
705         // Calculated support generation of randomly distributed number data.
706         return true;
707     }
709     public function custom_generator_tools_part($mform, $idx, $j) {
711         $minmaxgrp = array();
712         $minmaxgrp[] = $mform->createElement('text', "calcmin[$idx]",
713                 get_string('calcmin', 'qtype_calculated'));
714         $minmaxgrp[] = $mform->createElement('text', "calcmax[$idx]",
715                 get_string('calcmax', 'qtype_calculated'));
716         $mform->addGroup($minmaxgrp, 'minmaxgrp',
717                 get_string('minmax', 'qtype_calculated'), ' - ', false);
718         $mform->setType("calcmin[$idx]", PARAM_FLOAT);
719         $mform->setType("calcmax[$idx]", PARAM_FLOAT);
721         $precisionoptions = range(0, 10);
722         $mform->addElement('select', "calclength[$idx]",
723                 get_string('calclength', 'qtype_calculated'), $precisionoptions);
725         $distriboptions = array('uniform' => get_string('uniform', 'qtype_calculated'),
726                 'loguniform' => get_string('loguniform', 'qtype_calculated'));
727         $mform->addElement('select', "calcdistribution[$idx]",
728                 get_string('calcdistribution', 'qtype_calculated'), $distriboptions);
729     }
731     public function custom_generator_set_data($datasetdefs, $formdata) {
732         $idx = 1;
733         foreach ($datasetdefs as $datasetdef) {
734             if (preg_match('~^(uniform|loguniform):([^:]*):([^:]*):([0-9]*)$~',
735                     $datasetdef->options, $regs)) {
736                 $defid = "$datasetdef->type-$datasetdef->category-$datasetdef->name";
737                 $formdata["calcdistribution[$idx]"] = $regs[1];
738                 $formdata["calcmin[$idx]"] = $regs[2];
739                 $formdata["calcmax[$idx]"] = $regs[3];
740                 $formdata["calclength[$idx]"] = $regs[4];
741             }
742             $idx++;
743         }
744         return $formdata;
745     }
747     public function custom_generator_tools($datasetdef) {
748         global $OUTPUT;
749         if (preg_match('~^(uniform|loguniform):([^:]*):([^:]*):([0-9]*)$~',
750                 $datasetdef->options, $regs)) {
751             $defid = "$datasetdef->type-$datasetdef->category-$datasetdef->name";
752             for ($i = 0; $i<10; ++$i) {
753                 $lengthoptions[$i] = get_string(($regs[1] == 'uniform'
754                     ? 'decimals'
755                     : 'significantfigures'), 'qtype_calculated', $i);
756             }
757             $menu1 = html_writer::label(get_string('lengthoption', 'qtype_calculated'),
758                 'menucalclength', false, array('class' => 'accesshide'));
759             $menu1 .= html_writer::select($lengthoptions, 'calclength[]', $regs[4], null);
761             $options = array('uniform' => get_string('uniformbit', 'qtype_calculated'),
762                 'loguniform' => get_string('loguniformbit', 'qtype_calculated'));
763             $menu2 = html_writer::label(get_string('distributionoption', 'qtype_calculated'),
764                 'menucalcdistribution', false, array('class' => 'accesshide'));
765             $menu2 .= html_writer::select($options, 'calcdistribution[]', $regs[1], null);
766             return '<input type="submit" onclick="'
767                 . "getElementById('addform').regenerateddefid.value='$defid'; return true;"
768                 .'" value="'. get_string('generatevalue', 'qtype_calculated') . '"/><br/>'
769                 . '<input type="text" size="3" name="calcmin[]" '
770                 . " value=\"$regs[2]\"/> &amp; <input name=\"calcmax[]\" "
771                 . ' type="text" size="3" value="' . $regs[3] .'"/> '
772                 . $menu1 . '<br/>'
773                 . $menu2;
774         } else {
775             return '';
776         }
777     }
780     public function update_dataset_options($datasetdefs, $form) {
781         global $OUTPUT;
782         // Do we have information about new options ?
783         if (empty($form->definition) || empty($form->calcmin)
784                 ||empty($form->calcmax) || empty($form->calclength)
785                 || empty($form->calcdistribution)) {
786             // I guess not.
788         } else {
789             // Looks like we just could have some new information here.
790             $uniquedefs = array_values(array_unique($form->definition));
791             foreach ($uniquedefs as $key => $defid) {
792                 if (isset($datasetdefs[$defid])
793                         && is_numeric($form->calcmin[$key+1])
794                         && is_numeric($form->calcmax[$key+1])
795                         && is_numeric($form->calclength[$key+1])) {
796                     switch     ($form->calcdistribution[$key+1]) {
797                         case 'uniform': case 'loguniform':
798                             $datasetdefs[$defid]->options =
799                                 $form->calcdistribution[$key+1] . ':'
800                                 . $form->calcmin[$key+1] . ':'
801                                 . $form->calcmax[$key+1] . ':'
802                                 . $form->calclength[$key+1];
803                             break;
804                         default:
805                             echo $OUTPUT->notification(
806                                     "Unexpected distribution ".$form->calcdistribution[$key+1]);
807                     }
808                 }
809             }
810         }
812         // Look for empty options, on which we set default values.
813         foreach ($datasetdefs as $defid => $def) {
814             if (empty($def->options)) {
815                 $datasetdefs[$defid]->options = 'uniform:1.0:10.0:1';
816             }
817         }
818         return $datasetdefs;
819     }
821     public function save_question_calculated($question, $fromform) {
822         global $DB;
824         foreach ($question->options->answers as $key => $answer) {
825             if ($options = $DB->get_record('question_calculated', array('answer' => $key))) {
826                 $options->tolerance = trim($fromform->tolerance[$key]);
827                 $options->tolerancetype  = trim($fromform->tolerancetype[$key]);
828                 $options->correctanswerlength  = trim($fromform->correctanswerlength[$key]);
829                 $options->correctanswerformat  = trim($fromform->correctanswerformat[$key]);
830                 $DB->update_record('question_calculated', $options);
831             }
832         }
833     }
835     /**
836      * This function get the dataset items using id as unique parameter and return an
837      * array with itemnumber as index sorted ascendant
838      * If the multiple records with the same itemnumber exist, only the newest one
839      * i.e with the greatest id is used, the others are ignored but not deleted.
840      * MDL-19210
841      */
842     public function get_database_dataset_items($definition) {
843         global $CFG, $DB;
844         $databasedataitems = $DB->get_records_sql(// Use number as key!!
845             " SELECT id , itemnumber, definition,  value
846             FROM {question_dataset_items}
847             WHERE definition = $definition order by id DESC ", array($definition));
848         $dataitems = Array();
849         foreach ($databasedataitems as $id => $dataitem) {
850             if (!isset($dataitems[$dataitem->itemnumber])) {
851                 $dataitems[$dataitem->itemnumber] = $dataitem;
852             }
853         }
854         ksort($dataitems);
855         return $dataitems;
856     }
858     public function save_dataset_items($question, $fromform) {
859         global $CFG, $DB;
860         $synchronize = false;
861         if (isset($fromform->nextpageparam['forceregeneration'])) {
862             $regenerate = $fromform->nextpageparam['forceregeneration'];
863         } else {
864             $regenerate = 0;
865         }
866         if (empty($question->options)) {
867             $this->get_question_options($question);
868         }
869         if (!empty($question->options->synchronize)) {
870             $synchronize = true;
871         }
873         // Get the old datasets for this question.
874         $datasetdefs = $this->get_dataset_definitions($question->id, array());
875         // Handle generator options...
876         $olddatasetdefs = fullclone($datasetdefs);
877         $datasetdefs = $this->update_dataset_options($datasetdefs, $fromform);
878         $maxnumber = -1;
879         foreach ($datasetdefs as $defid => $datasetdef) {
880             if (isset($datasetdef->id)
881                     && $datasetdef->options != $olddatasetdefs[$defid]->options) {
882                 // Save the new value for options.
883                 $DB->update_record('question_dataset_definitions', $datasetdef);
885             }
886             // Get maxnumber.
887             if ($maxnumber == -1 || $datasetdef->itemcount < $maxnumber) {
888                 $maxnumber = $datasetdef->itemcount;
889             }
890         }
891         // Handle adding and removing of dataset items.
892         $i = 1;
893         if ($maxnumber > self::MAX_DATASET_ITEMS) {
894             $maxnumber = self::MAX_DATASET_ITEMS;
895         }
897         ksort($fromform->definition);
898         foreach ($fromform->definition as $key => $defid) {
899             // If the delete button has not been pressed then skip the datasetitems
900             // in the 'add item' part of the form.
901             if ($i > count($datasetdefs)*$maxnumber) {
902                 break;
903             }
904             $addeditem = new stdClass();
905             $addeditem->definition = $datasetdefs[$defid]->id;
906             $addeditem->value = $fromform->number[$i];
907             $addeditem->itemnumber = ceil($i / count($datasetdefs));
909             if ($fromform->itemid[$i]) {
910                 // Reuse any previously used record.
911                 $addeditem->id = $fromform->itemid[$i];
912                 $DB->update_record('question_dataset_items', $addeditem);
913             } else {
914                 $DB->insert_record('question_dataset_items', $addeditem);
915             }
917             $i++;
918         }
919         if (isset($addeditem->itemnumber) && $maxnumber < $addeditem->itemnumber
920                 && $addeditem->itemnumber < self::MAX_DATASET_ITEMS) {
921             $maxnumber = $addeditem->itemnumber;
922             foreach ($datasetdefs as $key => $newdef) {
923                 if (isset($newdef->id) && $newdef->itemcount <= $maxnumber) {
924                     $newdef->itemcount = $maxnumber;
925                     // Save the new value for options.
926                     $DB->update_record('question_dataset_definitions', $newdef);
927                 }
928             }
929         }
930         // Adding supplementary items.
931         $numbertoadd = 0;
932         if (isset($fromform->addbutton) && $fromform->selectadd > 0 &&
933                 $maxnumber < self::MAX_DATASET_ITEMS) {
934             $numbertoadd = $fromform->selectadd;
935             if (self::MAX_DATASET_ITEMS - $maxnumber < $numbertoadd) {
936                 $numbertoadd = self::MAX_DATASET_ITEMS - $maxnumber;
937             }
938             // Add the other items.
939             // Generate a new dataset item (or reuse an old one).
940             foreach ($datasetdefs as $defid => $datasetdef) {
941                 // In case that for category datasets some new items has been added,
942                 // get actual values.
943                 // Fix regenerate for this datadefs.
944                 $defregenerate = 0;
945                 if ($synchronize &&
946                         !empty ($fromform->nextpageparam["datasetregenerate[$datasetdef->name"])) {
947                     $defregenerate = 1;
948                 } else if (!$synchronize &&
949                         (($regenerate == 1 && $datasetdef->category == 0) ||$regenerate == 2)) {
950                     $defregenerate = 1;
951                 }
952                 if (isset($datasetdef->id)) {
953                     $datasetdefs[$defid]->items =
954                             $this->get_database_dataset_items($datasetdef->id);
955                 }
956                 for ($numberadded = $maxnumber+1; $numberadded <= $maxnumber + $numbertoadd; $numberadded++) {
957                     if (isset($datasetdefs[$defid]->items[$numberadded])) {
958                         // In case of regenerate it modifies the already existing record.
959                         if ($defregenerate) {
960                             $datasetitem = new stdClass();
961                             $datasetitem->id = $datasetdefs[$defid]->items[$numberadded]->id;
962                             $datasetitem->definition = $datasetdef->id;
963                             $datasetitem->itemnumber = $numberadded;
964                             $datasetitem->value =
965                                     $this->generate_dataset_item($datasetdef->options);
966                             $DB->update_record('question_dataset_items', $datasetitem);
967                         }
968                         // If not regenerate do nothing as there is already a record.
969                     } else {
970                         $datasetitem = new stdClass();
971                         $datasetitem->definition = $datasetdef->id;
972                         $datasetitem->itemnumber = $numberadded;
973                         if ($this->supports_dataset_item_generation()) {
974                             $datasetitem->value =
975                                     $this->generate_dataset_item($datasetdef->options);
976                         } else {
977                             $datasetitem->value = '';
978                         }
979                         $DB->insert_record('question_dataset_items', $datasetitem);
980                     }
981                 }// For number added.
982             }// Datasetsdefs end.
983             $maxnumber += $numbertoadd;
984             foreach ($datasetdefs as $key => $newdef) {
985                 if (isset($newdef->id) && $newdef->itemcount <= $maxnumber) {
986                     $newdef->itemcount = $maxnumber;
987                     // Save the new value for options.
988                     $DB->update_record('question_dataset_definitions', $newdef);
989                 }
990             }
991         }
993         if (isset($fromform->deletebutton)) {
994             if (isset($fromform->selectdelete)) {
995                 $newmaxnumber = $maxnumber-$fromform->selectdelete;
996             } else {
997                 $newmaxnumber = $maxnumber-1;
998             }
999             if ($newmaxnumber < 0) {
1000                 $newmaxnumber = 0;
1001             }
1002             foreach ($datasetdefs as $datasetdef) {
1003                 if ($datasetdef->itemcount == $maxnumber) {
1004                     $datasetdef->itemcount= $newmaxnumber;
1005                     $DB->update_record('question_dataset_definitions', $datasetdef);
1006                 }
1007             }
1008         }
1009     }
1010     public function generate_dataset_item($options) {
1011         if (!preg_match('~^(uniform|loguniform):([^:]*):([^:]*):([0-9]*)$~',
1012                 $options, $regs)) {
1013             // Unknown options...
1014             return false;
1015         }
1016         if ($regs[1] == 'uniform') {
1017             $nbr = $regs[2] + ($regs[3]-$regs[2])*mt_rand()/mt_getrandmax();
1018             return sprintf("%.".$regs[4].'f', $nbr);
1020         } else if ($regs[1] == 'loguniform') {
1021             $log0 = log(abs($regs[2])); // It would have worked the other way to.
1022             $nbr = exp($log0 + (log(abs($regs[3])) - $log0)*mt_rand()/mt_getrandmax());
1023             return sprintf("%.".$regs[4].'f', $nbr);
1025         } else {
1026             print_error('disterror', 'question', '', $regs[1]);
1027         }
1028         return '';
1029     }
1031     public function comment_header($question) {
1032         $strheader = '';
1033         $delimiter = '';
1035         $answers = $question->options->answers;
1037         foreach ($answers as $key => $answer) {
1038             $ans = shorten_text($answer->answer, 17, true);
1039             $strheader .= $delimiter.$ans;
1040             $delimiter = '<br/><br/><br/>';
1041         }
1042         return $strheader;
1043     }
1045     public function comment_on_datasetitems($qtypeobj, $questionid, $questiontext,
1046             $answers, $data, $number) {
1047         global $DB;
1048         $comment = new stdClass();
1049         $comment->stranswers = array();
1050         $comment->outsidelimit = false;
1051         $comment->answers = array();
1052         // Find a default unit.
1053         if (!empty($questionid) && $unit = $DB->get_record('question_numerical_units',
1054                 array('question' => $questionid, 'multiplier' => 1.0))) {
1055             $unit = $unit->unit;
1056         } else {
1057             $unit = '';
1058         }
1060         $answers = fullclone($answers);
1061         $errors = '';
1062         $delimiter = ': ';
1063         $virtualqtype =  $qtypeobj->get_virtual_qtype();
1064         foreach ($answers as $key => $answer) {
1065             $formula = $this->substitute_variables($answer->answer, $data);
1066             $formattedanswer = qtype_calculated_calculate_answer(
1067                 $answer->answer, $data, $answer->tolerance,
1068                 $answer->tolerancetype, $answer->correctanswerlength,
1069                 $answer->correctanswerformat, $unit);
1070             if ($formula === '*') {
1071                 $answer->min = ' ';
1072                 $formattedanswer->answer = $answer->answer;
1073             } else {
1074                 eval('$ansvalue = '.$formula.';');
1075                 $ans = new qtype_numerical_answer(0, $ansvalue, 0, '', 0, $answer->tolerance);
1076                 $ans->tolerancetype = $answer->tolerancetype;
1077                 list($answer->min, $answer->max) = $ans->get_tolerance_interval($answer);
1078             }
1079             if ($answer->min === '') {
1080                 // This should mean that something is wrong.
1081                 $comment->stranswers[$key] = " $formattedanswer->answer".'<br/><br/>';
1082             } else if ($formula === '*') {
1083                 $comment->stranswers[$key] = $formula . ' = ' .
1084                         get_string('anyvalue', 'qtype_calculated') . '<br/><br/><br/>';
1085             } else {
1086                 $formula = shorten_text($formula, 57, true);
1087                 $comment->stranswers[$key] = $formula . ' = ' . $formattedanswer->answer . '<br/>';
1088                 $correcttrue = new stdClass();
1089                 $correcttrue->correct = $formattedanswer->answer;
1090                 $correcttrue->true = '';
1091                 if ($formattedanswer->answer < $answer->min ||
1092                         $formattedanswer->answer > $answer->max) {
1093                     $comment->outsidelimit = true;
1094                     $comment->answers[$key] = $key;
1095                     $comment->stranswers[$key] .=
1096                             get_string('trueansweroutsidelimits', 'qtype_calculated', $correcttrue);
1097                 } else {
1098                     $comment->stranswers[$key] .=
1099                             get_string('trueanswerinsidelimits', 'qtype_calculated', $correcttrue);
1100                 }
1101                 $comment->stranswers[$key] .= '<br/>';
1102                 $comment->stranswers[$key] .= get_string('min', 'qtype_calculated') .
1103                         $delimiter . $answer->min . ' --- ';
1104                 $comment->stranswers[$key] .= get_string('max', 'qtype_calculated') .
1105                         $delimiter . $answer->max;
1106             }
1107         }
1108         return fullclone($comment);
1109     }
1111     public function tolerance_types() {
1112         return array(
1113             '1' => get_string('relative', 'qtype_numerical'),
1114             '2' => get_string('nominal', 'qtype_numerical'),
1115             '3' => get_string('geometric', 'qtype_numerical')
1116         );
1117     }
1119     public function dataset_options($form, $name, $mandatory = true,
1120             $renameabledatasets = false) {
1121         // Takes datasets from the parent implementation but
1122         // filters options that are currently not accepted by calculated.
1123         // It also determines a default selection.
1124         // Param $renameabledatasets not implemented anywhere.
1126         list($options, $selected) = $this->dataset_options_from_database(
1127                 $form, $name, '', 'qtype_calculated');
1129         foreach ($options as $key => $whatever) {
1130             if (!preg_match('~^1-~', $key) && $key != '0') {
1131                 unset($options[$key]);
1132             }
1133         }
1134         if (!$selected) {
1135             if ($mandatory) {
1136                 $selected =  "1-0-$name"; // Default.
1137             } else {
1138                 $selected = '0'; // Default.
1139             }
1140         }
1141         return array($options, $selected);
1142     }
1144     public function construct_dataset_menus($form, $mandatorydatasets,
1145             $optionaldatasets) {
1146         global $OUTPUT;
1147         $datasetmenus = array();
1148         foreach ($mandatorydatasets as $datasetname) {
1149             if (!isset($datasetmenus[$datasetname])) {
1150                 list($options, $selected) =
1151                     $this->dataset_options($form, $datasetname);
1152                 unset($options['0']); // Mandatory...
1153                 $datasetmenus[$datasetname] = html_writer::select(
1154                         $options, 'dataset[]', $selected, null);
1155             }
1156         }
1157         foreach ($optionaldatasets as $datasetname) {
1158             if (!isset($datasetmenus[$datasetname])) {
1159                 list($options, $selected) =
1160                     $this->dataset_options($form, $datasetname);
1161                 $datasetmenus[$datasetname] = html_writer::select(
1162                         $options, 'dataset[]', $selected, null);
1163             }
1164         }
1165         return $datasetmenus;
1166     }
1168     public function substitute_variables($str, $dataset) {
1169         global $OUTPUT;
1170         // Testing for wrong numerical values.
1171         // All calculations used this function so testing here should be OK.
1173         foreach ($dataset as $name => $value) {
1174             $val = $value;
1175             if (! is_numeric($val)) {
1176                 $a = new stdClass();
1177                 $a->name = '{'.$name.'}';
1178                 $a->value = $value;
1179                 echo $OUTPUT->notification(get_string('notvalidnumber', 'qtype_calculated', $a));
1180                 $val = 1.0;
1181             }
1182             if ($val <= 0) { // MDL-36025 Use parentheses for "-0" .
1183                 $str = str_replace('{'.$name.'}', '('.$val.')', $str);
1184             } else {
1185                 $str = str_replace('{'.$name.'}', $val, $str);
1186             }
1187         }
1188         return $str;
1189     }
1191     public function evaluate_equations($str, $dataset) {
1192         $formula = $this->substitute_variables($str, $dataset);
1193         if ($error = qtype_calculated_find_formula_errors($formula)) {
1194             return $error;
1195         }
1196         return $str;
1197     }
1199     public function substitute_variables_and_eval($str, $dataset) {
1200         $formula = $this->substitute_variables($str, $dataset);
1201         if ($error = qtype_calculated_find_formula_errors($formula)) {
1202             return $error;
1203         }
1204         // Calculate the correct answer.
1205         if (empty($formula)) {
1206             $str = '';
1207         } else if ($formula === '*') {
1208             $str = '*';
1209         } else {
1210             $str = null;
1211             eval('$str = '.$formula.';');
1212         }
1213         return $str;
1214     }
1216     public function get_dataset_definitions($questionid, $newdatasets) {
1217         global $DB;
1218         // Get the existing datasets for this question.
1219         $datasetdefs = array();
1220         if (!empty($questionid)) {
1221             global $CFG;
1222             $sql = "SELECT i.*
1223                       FROM {question_datasets} d, {question_dataset_definitions} i
1224                      WHERE d.question = ? AND d.datasetdefinition = i.id
1225                   ORDER BY i.id";
1226             if ($records = $DB->get_records_sql($sql, array($questionid))) {
1227                 foreach ($records as $r) {
1228                     $datasetdefs["$r->type-$r->category-$r->name"] = $r;
1229                 }
1230             }
1231         }
1233         foreach ($newdatasets as $dataset) {
1234             if (!$dataset) {
1235                 continue; // The no dataset case...
1236             }
1238             if (!isset($datasetdefs[$dataset])) {
1239                 // Make new datasetdef.
1240                 list($type, $category, $name) = explode('-', $dataset, 3);
1241                 $datasetdef = new stdClass();
1242                 $datasetdef->type = $type;
1243                 $datasetdef->name = $name;
1244                 $datasetdef->category  = $category;
1245                 $datasetdef->itemcount = 0;
1246                 $datasetdef->options   = 'uniform:1.0:10.0:1';
1247                 $datasetdefs[$dataset] = clone($datasetdef);
1248             }
1249         }
1250         return $datasetdefs;
1251     }
1253     public function save_dataset_definitions($form) {
1254         global $DB;
1255         // Save synchronize.
1257         if (empty($form->dataset)) {
1258             $form->dataset = array();
1259         }
1260         // Save datasets.
1261         $datasetdefinitions = $this->get_dataset_definitions($form->id, $form->dataset);
1262         $tmpdatasets = array_flip($form->dataset);
1263         $defids = array_keys($datasetdefinitions);
1264         foreach ($defids as $defid) {
1265             $datasetdef = &$datasetdefinitions[$defid];
1266             if (isset($datasetdef->id)) {
1267                 if (!isset($tmpdatasets[$defid])) {
1268                     // This dataset is not used any more, delete it.
1269                     $DB->delete_records('question_datasets',
1270                             array('question' => $form->id, 'datasetdefinition' => $datasetdef->id));
1271                     if ($datasetdef->category == 0) {
1272                         // Question local dataset.
1273                         $DB->delete_records('question_dataset_definitions',
1274                                 array('id' => $datasetdef->id));
1275                         $DB->delete_records('question_dataset_items',
1276                                 array('definition' => $datasetdef->id));
1277                     }
1278                 }
1279                 // This has already been saved or just got deleted.
1280                 unset($datasetdefinitions[$defid]);
1281                 continue;
1282             }
1284             $datasetdef->id = $DB->insert_record('question_dataset_definitions', $datasetdef);
1286             if (0 != $datasetdef->category) {
1287                 // We need to look for already existing datasets in the category.
1288                 // First creating the datasetdefinition above
1289                 // then we can manage to automatically take care of some possible realtime concurrence.
1291                 if ($olderdatasetdefs = $DB->get_records_select('question_dataset_definitions',
1292                         'type = ? AND name = ? AND category = ? AND id < ?
1293                         ORDER BY id DESC',
1294                         array($datasetdef->type, $datasetdef->name,
1295                                 $datasetdef->category, $datasetdef->id))) {
1297                     while ($olderdatasetdef = array_shift($olderdatasetdefs)) {
1298                         $DB->delete_records('question_dataset_definitions',
1299                                 array('id' => $datasetdef->id));
1300                         $datasetdef = $olderdatasetdef;
1301                     }
1302                 }
1303             }
1305             // Create relation to this dataset.
1306             $questiondataset = new stdClass();
1307             $questiondataset->question = $form->id;
1308             $questiondataset->datasetdefinition = $datasetdef->id;
1309             $DB->insert_record('question_datasets', $questiondataset);
1310             unset($datasetdefinitions[$defid]);
1311         }
1313         // Remove local obsolete datasets as well as relations
1314         // to datasets in other categories.
1315         if (!empty($datasetdefinitions)) {
1316             foreach ($datasetdefinitions as $def) {
1317                 $DB->delete_records('question_datasets',
1318                         array('question' => $form->id, 'datasetdefinition' => $def->id));
1320                 if ($def->category == 0) { // Question local dataset.
1321                     $DB->delete_records('question_dataset_definitions',
1322                             array('id' => $def->id));
1323                     $DB->delete_records('question_dataset_items',
1324                             array('definition' => $def->id));
1325                 }
1326             }
1327         }
1328     }
1329     /** This function create a copy of the datasets (definition and dataitems)
1330      * from the preceding question if they remain in the new question
1331      * otherwise its create the datasets that have been added as in the
1332      * save_dataset_definitions()
1333      */
1334     public function save_as_new_dataset_definitions($form, $initialid) {
1335         global $CFG, $DB;
1336         // Get the datasets from the intial question.
1337         $datasetdefinitions = $this->get_dataset_definitions($initialid, $form->dataset);
1338         // Param $tmpdatasets contains those of the new question.
1339         $tmpdatasets = array_flip($form->dataset);
1340         $defids = array_keys($datasetdefinitions);// New datasets.
1341         foreach ($defids as $defid) {
1342             $datasetdef = &$datasetdefinitions[$defid];
1343             if (isset($datasetdef->id)) {
1344                 // This dataset exist in the initial question.
1345                 if (!isset($tmpdatasets[$defid])) {
1346                     // Do not exist in the new question so ignore.
1347                     unset($datasetdefinitions[$defid]);
1348                     continue;
1349                 }
1350                 // Create a copy but not for category one.
1351                 if (0 == $datasetdef->category) {
1352                     $olddatasetid = $datasetdef->id;
1353                     $olditemcount = $datasetdef->itemcount;
1354                     $datasetdef->itemcount = 0;
1355                     $datasetdef->id = $DB->insert_record('question_dataset_definitions',
1356                             $datasetdef);
1357                     // Copy the dataitems.
1358                     $olditems = $this->get_database_dataset_items($olddatasetid);
1359                     if (count($olditems) > 0) {
1360                         $itemcount = 0;
1361                         foreach ($olditems as $item) {
1362                             $item->definition = $datasetdef->id;
1363                             $DB->insert_record('question_dataset_items', $item);
1364                             $itemcount++;
1365                         }
1366                         // Update item count to olditemcount if
1367                         // at least this number of items has been recover from the database.
1368                         if ($olditemcount <= $itemcount) {
1369                             $datasetdef->itemcount = $olditemcount;
1370                         } else {
1371                             $datasetdef->itemcount = $itemcount;
1372                         }
1373                         $DB->update_record('question_dataset_definitions', $datasetdef);
1374                     } // End of  copy the dataitems.
1375                 }// End of  copy the datasetdef.
1376                 // Create relation to the new question with this
1377                 // copy as new datasetdef from the initial question.
1378                 $questiondataset = new stdClass();
1379                 $questiondataset->question = $form->id;
1380                 $questiondataset->datasetdefinition = $datasetdef->id;
1381                 $DB->insert_record('question_datasets', $questiondataset);
1382                 unset($datasetdefinitions[$defid]);
1383                 continue;
1384             }// End of datasetdefs from the initial question.
1385             // Really new one code similar to save_dataset_definitions().
1386             $datasetdef->id = $DB->insert_record('question_dataset_definitions', $datasetdef);
1388             if (0 != $datasetdef->category) {
1389                 // We need to look for already existing
1390                 // datasets in the category.
1391                 // By first creating the datasetdefinition above we
1392                 // can manage to automatically take care of
1393                 // some possible realtime concurrence.
1394                 if ($olderdatasetdefs = $DB->get_records_select('question_dataset_definitions',
1395                         "type = ? AND name = ? AND category = ? AND id < ?
1396                         ORDER BY id DESC",
1397                         array($datasetdef->type, $datasetdef->name,
1398                                 $datasetdef->category, $datasetdef->id))) {
1400                     while ($olderdatasetdef = array_shift($olderdatasetdefs)) {
1401                         $DB->delete_records('question_dataset_definitions',
1402                                 array('id' => $datasetdef->id));
1403                         $datasetdef = $olderdatasetdef;
1404                     }
1405                 }
1406             }
1408             // Create relation to this dataset.
1409             $questiondataset = new stdClass();
1410             $questiondataset->question = $form->id;
1411             $questiondataset->datasetdefinition = $datasetdef->id;
1412             $DB->insert_record('question_datasets', $questiondataset);
1413             unset($datasetdefinitions[$defid]);
1414         }
1416         // Remove local obsolete datasets as well as relations
1417         // to datasets in other categories.
1418         if (!empty($datasetdefinitions)) {
1419             foreach ($datasetdefinitions as $def) {
1420                 $DB->delete_records('question_datasets',
1421                         array('question' => $form->id, 'datasetdefinition' => $def->id));
1423                 if ($def->category == 0) { // Question local dataset.
1424                     $DB->delete_records('question_dataset_definitions',
1425                             array('id' => $def->id));
1426                     $DB->delete_records('question_dataset_items',
1427                             array('definition' => $def->id));
1428                 }
1429             }
1430         }
1431     }
1433     // Dataset functionality.
1434     public function pick_question_dataset($question, $datasetitem) {
1435         // Select a dataset in the following format:
1436         // an array indexed by the variable names (d.name) pointing to the value
1437         // to be substituted.
1438         global $CFG, $DB;
1439         if (!$dataitems = $DB->get_records_sql(
1440                 "SELECT i.id, d.name, i.value
1441                    FROM {question_dataset_definitions} d,
1442                         {question_dataset_items} i,
1443                         {question_datasets} q
1444                   WHERE q.question = ?
1445                     AND q.datasetdefinition = d.id
1446                     AND d.id = i.definition
1447                     AND i.itemnumber = ?
1448                ORDER BY i.id DESC ", array($question->id, $datasetitem))) {
1449             $a = new stdClass();
1450             $a->id = $question->id;
1451             $a->item = $datasetitem;
1452             print_error('cannotgetdsfordependent', 'question', '', $a);
1453         }
1454         $dataset = Array();
1455         foreach ($dataitems as $id => $dataitem) {
1456             if (!isset($dataset[$dataitem->name])) {
1457                 $dataset[$dataitem->name] = $dataitem->value;
1458             }
1459         }
1460         return $dataset;
1461     }
1463     public function dataset_options_from_database($form, $name, $prefix = '',
1464             $langfile = 'qtype_calculated') {
1465         global $CFG, $DB;
1466         $type = 1; // Only type = 1 (i.e. old 'LITERAL') has ever been used.
1467         // First options - it is not a dataset...
1468         $options['0'] = get_string($prefix.'nodataset', $langfile);
1469         // New question no local.
1470         if (!isset($form->id) || $form->id == 0) {
1471             $key = "$type-0-$name";
1472             $options[$key] = get_string($prefix."newlocal$type", $langfile);
1473             $currentdatasetdef = new stdClass();
1474             $currentdatasetdef->type = '0';
1475         } else {
1476             // Construct question local options.
1477             $sql = "SELECT a.*
1478                 FROM {question_dataset_definitions} a, {question_datasets} b
1479                WHERE a.id = b.datasetdefinition AND a.type = '1' AND b.question = ? AND a.name = ?";
1480             $currentdatasetdef = $DB->get_record_sql($sql, array($form->id, $name));
1481             if (!$currentdatasetdef) {
1482                 $currentdatasetdef = new stdClass();
1483                 $currentdatasetdef->type = '0';
1484             }
1485             $key = "$type-0-$name";
1486             if ($currentdatasetdef->type == $type
1487                     and $currentdatasetdef->category == 0) {
1488                 $options[$key] = get_string($prefix."keptlocal$type", $langfile);
1489             } else {
1490                 $options[$key] = get_string($prefix."newlocal$type", $langfile);
1491             }
1492         }
1493         // Construct question category options.
1494         $categorydatasetdefs = $DB->get_records_sql(
1495             "SELECT b.question, a.*
1496             FROM {question_datasets} b,
1497             {question_dataset_definitions} a
1498             WHERE a.id = b.datasetdefinition
1499             AND a.type = '1'
1500             AND a.category = ?
1501             AND a.name = ?", array($form->category, $name));
1502         $type = 1;
1503         $key = "$type-$form->category-$name";
1504         if (!empty($categorydatasetdefs)) {
1505             // There is at least one with the same name.
1506             if (isset($form->id) && isset($categorydatasetdefs[$form->id])) {
1507                 // It is already used by this question.
1508                 $options[$key] = get_string($prefix."keptcategory$type", $langfile);
1509             } else {
1510                 $options[$key] = get_string($prefix."existingcategory$type", $langfile);
1511             }
1512         } else {
1513             $options[$key] = get_string($prefix."newcategory$type", $langfile);
1514         }
1515         // All done!
1516         return array($options, $currentdatasetdef->type
1517             ? "$currentdatasetdef->type-$currentdatasetdef->category-$name"
1518             : '');
1519     }
1521     public function find_dataset_names($text) {
1522         // Returns the possible dataset names found in the text as an array.
1523         // The array has the dataset name for both key and value.
1524         $datasetnames = array();
1525         while (preg_match('~\\{([[:alpha:]][^>} <{"\']*)\\}~', $text, $regs)) {
1526             $datasetnames[$regs[1]] = $regs[1];
1527             $text = str_replace($regs[0], '', $text);
1528         }
1529         return $datasetnames;
1530     }
1532     /**
1533      * This function retrieve the item count of the available category shareable
1534      * wild cards that is added as a comment displayed when a wild card with
1535      * the same name is displayed in datasetdefinitions_form.php
1536      */
1537     public function get_dataset_definitions_category($form) {
1538         global $CFG, $DB;
1539         $datasetdefs = array();
1540         $lnamemax = 30;
1541         if (!empty($form->category)) {
1542             $sql = "SELECT i.*, d.*
1543                       FROM {question_datasets} d, {question_dataset_definitions} i
1544                      WHERE i.id = d.datasetdefinition AND i.category = ?";
1545             if ($records = $DB->get_records_sql($sql, array($form->category))) {
1546                 foreach ($records as $r) {
1547                     if (!isset ($datasetdefs["$r->name"])) {
1548                         $datasetdefs["$r->name"] = $r->itemcount;
1549                     }
1550                 }
1551             }
1552         }
1553         return $datasetdefs;
1554     }
1556     /**
1557      * This function build a table showing the available category shareable
1558      * wild cards, their name, their definition (Min, Max, Decimal) , the item count
1559      * and the name of the question where they are used.
1560      * This table is intended to be add before the question text to help the user use
1561      * these wild cards
1562      */
1563     public function print_dataset_definitions_category($form) {
1564         global $CFG, $DB;
1565         $datasetdefs = array();
1566         $lnamemax = 22;
1567         $namestr          = get_string('name');
1568         $rangeofvaluestr  = get_string('minmax', 'qtype_calculated');
1569         $questionusingstr = get_string('usedinquestion', 'qtype_calculated');
1570         $itemscountstr    = get_string('itemscount', 'qtype_calculated');
1571         $text = '';
1572         if (!empty($form->category)) {
1573             list($category) = explode(',', $form->category);
1574             $sql = "SELECT i.*, d.*
1575                 FROM {question_datasets} d,
1576         {question_dataset_definitions} i
1577         WHERE i.id = d.datasetdefinition
1578         AND i.category = ?";
1579             if ($records = $DB->get_records_sql($sql, array($category))) {
1580                 foreach ($records as $r) {
1581                     $sql1 = "SELECT q.*
1582                                FROM {question} q
1583                               WHERE q.id = ?";
1584                     if (!isset ($datasetdefs["$r->type-$r->category-$r->name"])) {
1585                         $datasetdefs["$r->type-$r->category-$r->name"] = $r;
1586                     }
1587                     if ($questionb = $DB->get_records_sql($sql1, array($r->question))) {
1588                         if (!isset ($datasetdefs["$r->type-$r->category-$r->name"]->questions[$r->question])) {
1589                             $datasetdefs["$r->type-$r->category-$r->name"]->questions[$r->question] = new stdClass();
1590                         }
1591                         $datasetdefs["$r->type-$r->category-$r->name"]->questions[
1592                                 $r->question]->name = $questionb[$r->question]->name;
1593                     }
1594                 }
1595             }
1596         }
1597         if (!empty ($datasetdefs)) {
1599             $text = "<table width=\"100%\" border=\"1\"><tr>
1600                     <th style=\"white-space:nowrap;\" class=\"header\"
1601                             scope=\"col\">$namestr</th>
1602                     <th style=\"white-space:nowrap;\" class=\"header\"
1603                             scope=\"col\">$rangeofvaluestr</th>
1604                     <th style=\"white-space:nowrap;\" class=\"header\"
1605                             scope=\"col\">$itemscountstr</th>
1606                     <th style=\"white-space:nowrap;\" class=\"header\"
1607                             scope=\"col\">$questionusingstr</th>
1608                     </tr>";
1609             foreach ($datasetdefs as $datasetdef) {
1610                 list($distribution, $min, $max, $dec) = explode(':', $datasetdef->options, 4);
1611                 $text .= "<tr>
1612                         <td valign=\"top\" align=\"center\">$datasetdef->name</td>
1613                         <td align=\"center\" valign=\"top\">$min <strong>-</strong> $max</td>
1614                         <td align=\"right\" valign=\"top\">$datasetdef->itemcount&nbsp;&nbsp;</td>
1615                         <td align=\"left\">";
1616                 foreach ($datasetdef->questions as $qu) {
1617                     // Limit the name length displayed.
1618                     if (!empty($qu->name)) {
1619                         $qu->name = (strlen($qu->name) > $lnamemax) ?
1620                             substr($qu->name, 0, $lnamemax).'...' : $qu->name;
1621                     } else {
1622                         $qu->name = '';
1623                     }
1624                     $text .= " &nbsp;&nbsp; $qu->name <br/>";
1625                 }
1626                 $text .= "</td></tr>";
1627             }
1628             $text .= "</table>";
1629         } else {
1630             $text .= get_string('nosharedwildcard', 'qtype_calculated');
1631         }
1632         return $text;
1633     }
1635     /**
1636      * This function build a table showing the available category shareable
1637      * wild cards, their name, their definition (Min, Max, Decimal) , the item count
1638      * and the name of the question where they are used.
1639      * This table is intended to be add before the question text to help the user use
1640      * these wild cards
1641      */
1643     public function print_dataset_definitions_category_shared($question, $datasetdefsq) {
1644         global $CFG, $DB;
1645         $datasetdefs = array();
1646         $lnamemax = 22;
1647         $namestr          = get_string('name', 'quiz');
1648         $rangeofvaluestr  = get_string('minmax', 'qtype_calculated');
1649         $questionusingstr = get_string('usedinquestion', 'qtype_calculated');
1650         $itemscountstr    = get_string('itemscount', 'qtype_calculated');
1651         $text = '';
1652         if (!empty($question->category)) {
1653             list($category) = explode(',', $question->category);
1654             $sql = "SELECT i.*, d.*
1655                       FROM {question_datasets} d, {question_dataset_definitions} i
1656                      WHERE i.id = d.datasetdefinition AND i.category = ?";
1657             if ($records = $DB->get_records_sql($sql, array($category))) {
1658                 foreach ($records as $r) {
1659                     $key = "$r->type-$r->category-$r->name";
1660                     $sql1 = "SELECT q.*
1661                                FROM {question} q
1662                               WHERE q.id = ?";
1663                     if (!isset($datasetdefs[$key])) {
1664                         $datasetdefs[$key] = $r;
1665                     }
1666                     if ($questionb = $DB->get_records_sql($sql1, array($r->question))) {
1667                         $datasetdefs[$key]->questions[$r->question] = new stdClass();
1668                         $datasetdefs[$key]->questions[$r->question]->name =
1669                                 $questionb[$r->question]->name;
1670                         $datasetdefs[$key]->questions[$r->question]->id =
1671                                 $questionb[$r->question]->id;
1672                     }
1673                 }
1674             }
1675         }
1676         if (!empty ($datasetdefs)) {
1678             $text  = "<table width=\"100%\" border=\"1\"><tr>
1679                     <th style=\"white-space:nowrap;\" class=\"header\"
1680                             scope=\"col\">$namestr</th>";
1681             $text .= "<th style=\"white-space:nowrap;\" class=\"header\"
1682                     scope=\"col\">$itemscountstr</th>";
1683             $text .= "<th style=\"white-space:nowrap;\" class=\"header\"
1684                     scope=\"col\">&nbsp;&nbsp;$questionusingstr &nbsp;&nbsp;</th>";
1685             $text .= "<th style=\"white-space:nowrap;\" class=\"header\"
1686                     scope=\"col\">Quiz</th>";
1687             $text .= "<th style=\"white-space:nowrap;\" class=\"header\"
1688                     scope=\"col\">Attempts</th></tr>";
1689             foreach ($datasetdefs as $datasetdef) {
1690                 list($distribution, $min, $max, $dec) = explode(':', $datasetdef->options, 4);
1691                 $count = count($datasetdef->questions);
1692                 $text .= "<tr>
1693                         <td style=\"white-space:nowrap;\" valign=\"top\"
1694                                 align=\"center\" rowspan=\"$count\"> $datasetdef->name </td>
1695                         <td align=\"right\" valign=\"top\"
1696                                 rowspan=\"$count\">$datasetdef->itemcount</td>";
1697                 $line = 0;
1698                 foreach ($datasetdef->questions as $qu) {
1699                     // Limit the name length displayed.
1700                     if (!empty($qu->name)) {
1701                         $qu->name = (strlen($qu->name) > $lnamemax) ?
1702                             substr($qu->name, 0, $lnamemax).'...' : $qu->name;
1703                     } else {
1704                         $qu->name = '';
1705                     }
1706                     if ($line) {
1707                         $text .= "<tr>";
1708                     }
1709                     $line++;
1710                     $text .= "<td align=\"left\" style=\"white-space:nowrap;\">$qu->name</td>";
1711                     // TODO MDL-43779 should not have quiz-specific code here.
1712                     $nbofquiz = $DB->count_records('quiz_slots', array('questionid' => $qu->id));
1713                     $nbofattempts = $DB->count_records_sql("
1714                             SELECT count(1)
1715                               FROM {quiz_slots} slot
1716                               JOIN {quiz_attempts} quiza ON quiza.quiz = slot.quizid
1717                              WHERE slot.questionid = ?
1718                                AND quiza.preview = 0", array($qu->id));
1719                     if ($nbofquiz > 0) {
1720                         $text .= "<td align=\"center\">$nbofquiz</td>";
1721                         $text .= "<td align=\"center\">$nbofattempts";
1722                     } else {
1723                         $text .= "<td align=\"center\">0</td>";
1724                         $text .= "<td align=\"left\"><br/>";
1725                     }
1727                     $text .= "</td></tr>";
1728                 }
1729             }
1730             $text .= "</table>";
1731         } else {
1732             $text .= get_string('nosharedwildcard', 'qtype_calculated');
1733         }
1734         return $text;
1735     }
1737     public function find_math_equations($text) {
1738         // Returns the possible dataset names found in the text as an array.
1739         // The array has the dataset name for both key and value.
1740         $equations = array();
1741         while (preg_match('~\{=([^[:space:]}]*)}~', $text, $regs)) {
1742             $equations[] = $regs[1];
1743             $text = str_replace($regs[0], '', $text);
1744         }
1745         return $equations;
1746     }
1748     public function get_virtual_qtype() {
1749         return question_bank::get_qtype('numerical');
1750     }
1752     public function get_possible_responses($questiondata) {
1753         $responses = array();
1755         $virtualqtype = $this->get_virtual_qtype();
1756         $unit = $virtualqtype->get_default_numerical_unit($questiondata);
1758         $tolerancetypes = $this->tolerance_types();
1760         $starfound = false;
1761         foreach ($questiondata->options->answers as $aid => $answer) {
1762             $responseclass = $answer->answer;
1764             if ($responseclass === '*') {
1765                 $starfound = true;
1766             } else {
1767                 $a = new stdClass();
1768                 $a->answer = $virtualqtype->add_unit($questiondata, $responseclass, $unit);
1769                 $a->tolerance = $answer->tolerance;
1770                 $a->tolerancetype = $tolerancetypes[$answer->tolerancetype];
1772                 $responseclass = get_string('answerwithtolerance', 'qtype_calculated', $a);
1773             }
1775             $responses[$aid] = new question_possible_response($responseclass,
1776                     $answer->fraction);
1777         }
1779         if (!$starfound) {
1780             $responses[0] = new question_possible_response(
1781             get_string('didnotmatchanyanswer', 'question'), 0);
1782         }
1784         $responses[null] = question_possible_response::no_response();
1786         return array($questiondata->id => $responses);
1787     }
1789     public function move_files($questionid, $oldcontextid, $newcontextid) {
1790         $fs = get_file_storage();
1792         parent::move_files($questionid, $oldcontextid, $newcontextid);
1793         $this->move_files_in_answers($questionid, $oldcontextid, $newcontextid);
1794         $this->move_files_in_hints($questionid, $oldcontextid, $newcontextid);
1795     }
1797     protected function delete_files($questionid, $contextid) {
1798         $fs = get_file_storage();
1800         parent::delete_files($questionid, $contextid);
1801         $this->delete_files_in_answers($questionid, $contextid);
1802         $this->delete_files_in_hints($questionid, $contextid);
1803     }
1807 function qtype_calculated_calculate_answer($formula, $individualdata,
1808     $tolerance, $tolerancetype, $answerlength, $answerformat = '1', $unit = '') {
1809     // The return value has these properties: .
1810     // ->answer    the correct answer
1811     // ->min       the lower bound for an acceptable response
1812     // ->max       the upper bound for an accetpable response.
1813     $calculated = new stdClass();
1814     // Exchange formula variables with the correct values...
1815     $answer = question_bank::get_qtype('calculated')->substitute_variables_and_eval(
1816             $formula, $individualdata);
1817     if (!is_numeric($answer)) {
1818         // Something went wrong, so just return NaN.
1819         $calculated->answer = NAN;
1820         return $calculated;
1821     }
1822     if ('1' == $answerformat) { // Answer is to have $answerlength decimals.
1823         // Decimal places.
1824         $calculated->answer = sprintf('%.' . $answerlength . 'F', $answer);
1826     } else if ($answer) { // Significant figures does only apply if the result is non-zero.
1828         // Convert to positive answer...
1829         if ($answer < 0) {
1830             $answer = -$answer;
1831             $sign = '-';
1832         } else {
1833             $sign = '';
1834         }
1836         // Determine the format 0.[1-9][0-9]* for the answer...
1837         $p10 = 0;
1838         while ($answer < 1) {
1839             --$p10;
1840             $answer *= 10;
1841         }
1842         while ($answer >= 1) {
1843             ++$p10;
1844             $answer /= 10;
1845         }
1846         // ... and have the answer rounded of to the correct length.
1847         $answer = round($answer, $answerlength);
1849         // If we rounded up to 1.0, place the answer back into 0.[1-9][0-9]* format.
1850         if ($answer >= 1) {
1851             ++$p10;
1852             $answer /= 10;
1853         }
1855         // Have the answer written on a suitable format:
1856         // either scientific or plain numeric.
1857         if (-2 > $p10 || 4 < $p10) {
1858             // Use scientific format.
1859             $exponent = 'e'.--$p10;
1860             $answer *= 10;
1861             if (1 == $answerlength) {
1862                 $calculated->answer = $sign.$answer.$exponent;
1863             } else {
1864                 // Attach additional zeros at the end of $answer.
1865                 $answer .= (1 == strlen($answer) ? '.' : '')
1866                     . '00000000000000000000000000000000000000000x';
1867                 $calculated->answer = $sign
1868                     .substr($answer, 0, $answerlength +1).$exponent;
1869             }
1870         } else {
1871             // Stick to plain numeric format.
1872             $answer *= "1e$p10";
1873             if (0.1 <= $answer / "1e$answerlength") {
1874                 $calculated->answer = $sign.$answer;
1875             } else {
1876                 // Could be an idea to add some zeros here.
1877                 $answer .= (preg_match('~^[0-9]*$~', $answer) ? '.' : '')
1878                     . '00000000000000000000000000000000000000000x';
1879                 $oklen = $answerlength + ($p10 < 1 ? 2-$p10 : 1);
1880                 $calculated->answer = $sign.substr($answer, 0, $oklen);
1881             }
1882         }
1884     } else {
1885         $calculated->answer = 0.0;
1886     }
1887     if ($unit != '') {
1888             $calculated->answer = $calculated->answer . ' ' . $unit;
1889     }
1891     // Return the result.
1892     return $calculated;
1896 /**
1897  * Validate a forumula.
1898  * @param string $formula the formula to validate.
1899  * @return string|boolean false if there are no problems. Otherwise a string error message.
1900  */
1901 function qtype_calculated_find_formula_errors($formula) {
1902     // Validates the formula submitted from the question edit page.
1903     // Returns false if everything is alright
1904     // otherwise it constructs an error message.
1905     // Strip away dataset names.
1906     while (preg_match('~\\{[[:alpha:]][^>} <{"\']*\\}~', $formula, $regs)) {
1907         $formula = str_replace($regs[0], '1', $formula);
1908     }
1910     // Strip away empty space and lowercase it.
1911     $formula = strtolower(str_replace(' ', '', $formula));
1913     $safeoperatorchar = '-+/*%>:^\~<?=&|!'; /* */
1914     $operatorornumber = "[$safeoperatorchar.0-9eE]";
1916     while (preg_match("~(^|[$safeoperatorchar,(])([a-z0-9_]*)" .
1917             "\\(($operatorornumber+(,$operatorornumber+((,$operatorornumber+)+)?)?)?\\)~",
1918         $formula, $regs)) {
1919         switch ($regs[2]) {
1920             // Simple parenthesis.
1921             case '':
1922                 if ((isset($regs[4]) && $regs[4]) || strlen($regs[3]) == 0) {
1923                     return get_string('illegalformulasyntax', 'qtype_calculated', $regs[0]);
1924                 }
1925                 break;
1927                 // Zero argument functions.
1928             case 'pi':
1929                 if (array_key_exists(3, $regs)) {
1930                     return get_string('functiontakesnoargs', 'qtype_calculated', $regs[2]);
1931                 }
1932                 break;
1934                 // Single argument functions (the most common case).
1935             case 'abs': case 'acos': case 'acosh': case 'asin': case 'asinh':
1936             case 'atan': case 'atanh': case 'bindec': case 'ceil': case 'cos':
1937             case 'cosh': case 'decbin': case 'decoct': case 'deg2rad':
1938             case 'exp': case 'expm1': case 'floor': case 'is_finite':
1939             case 'is_infinite': case 'is_nan': case 'log10': case 'log1p':
1940             case 'octdec': case 'rad2deg': case 'sin': case 'sinh': case 'sqrt':
1941             case 'tan': case 'tanh':
1942                 if (!empty($regs[4]) || empty($regs[3])) {
1943                     return get_string('functiontakesonearg', 'qtype_calculated', $regs[2]);
1944                 }
1945                 break;
1947                 // Functions that take one or two arguments.
1948             case 'log': case 'round':
1949                 if (!empty($regs[5]) || empty($regs[3])) {
1950                     return get_string('functiontakesoneortwoargs', 'qtype_calculated', $regs[2]);
1951                 }
1952                 break;
1954                 // Functions that must have two arguments.
1955             case 'atan2': case 'fmod': case 'pow':
1956                 if (!empty($regs[5]) || empty($regs[4])) {
1957                     return get_string('functiontakestwoargs', 'qtype_calculated', $regs[2]);
1958                 }
1959                 break;
1961                 // Functions that take two or more arguments.
1962             case 'min': case 'max':
1963                 if (empty($regs[4])) {
1964                     return get_string('functiontakesatleasttwo', 'qtype_calculated', $regs[2]);
1965                 }
1966                 break;
1968             default:
1969                 return get_string('unsupportedformulafunction', 'qtype_calculated', $regs[2]);
1970         }
1972         // Exchange the function call with '1' and then check for
1973         // another function call...
1974         if ($regs[1]) {
1975             // The function call is proceeded by an operator.
1976             $formula = str_replace($regs[0], $regs[1] . '1', $formula);
1977         } else {
1978             // The function call starts the formula.
1979             $formula = preg_replace("~^$regs[2]\\([^)]*\\)~", '1', $formula);
1980         }
1981     }
1983     if (preg_match("~[^$safeoperatorchar.0-9eE]+~", $formula, $regs)) {
1984         return get_string('illegalformulasyntax', 'qtype_calculated', $regs[0]);
1985     } else {
1986         // Formula just might be valid.
1987         return false;
1988     }
1991 /**
1992  * Validate all the forumulas in a bit of text.
1993  * @param string $text the text in which to validate the formulas.
1994  * @return string|boolean false if there are no problems. Otherwise a string error message.
1995  */
1996 function qtype_calculated_find_formula_errors_in_text($text) {
1997     preg_match_all(qtype_calculated::FORMULAS_IN_TEXT_REGEX, $text, $matches);
1999     $errors = array();
2000     foreach ($matches[1] as $match) {
2001         $error = qtype_calculated_find_formula_errors($match);
2002         if ($error) {
2003             $errors[] = $error;
2004         }
2005     }
2007     if ($errors) {
2008         return implode(' ', $errors);
2009     }
2011     return false;