MDL-51090: mod_quiz grading validation of an essay question
[moodle.git] / question / engine / questionattempt.php
CommitLineData
dcd03928 1<?php
dcd03928
TH
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/>.
16
17/**
18 * This file defines the question attempt class, and a few related classes.
19 *
20 * @package moodlecore
21 * @subpackage questionengine
22 * @copyright 2009 The Open University
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26
27defined('MOODLE_INTERNAL') || die();
28
29
30/**
31 * Tracks an attempt at one particular question in a {@link question_usage_by_activity}.
32 *
33 * Most calling code should need to access objects of this class. They should be
34 * able to do everything through the usage interface. This class is an internal
35 * implementation detail of the question engine.
36 *
37 * Instances of this class correspond to rows in the question_attempts table, and
38 * a collection of {@link question_attempt_steps}. Question inteaction models and
39 * question types do work with question_attempt objects.
40 *
41 * @copyright 2009 The Open University
42 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43 */
44class question_attempt {
45 /**
46 * @var string this is a magic value that question types can return from
47 * {@link question_definition::get_expected_data()}.
48 */
49 const USE_RAW_DATA = 'use raw data';
50
51 /**
61cca0b7 52 * @var string special value used by manual grading because {@link PARAM_FLOAT}
dcd03928
TH
53 * converts '' to 0.
54 */
55 const PARAM_MARK = 'parammark';
56
57 /**
58 * @var string special value to indicate a response variable that is uploaded
59 * files.
60 */
61 const PARAM_FILES = 'paramfiles';
62
63 /**
64 * @var string special value to indicate a response variable that is uploaded
65 * files.
66 */
2d2018ab 67 const PARAM_RAW_FILES = 'paramrawfiles';
dcd03928 68
99caa248
JP
69 /**
70 * @var string means first try at a question during an attempt by a user.
71 */
72 const FIRST_TRY = 'firsttry';
73
74 /**
75 * @var string means last try at a question during an attempt by a user.
76 */
77 const LAST_TRY = 'lasttry';
78
79 /**
80 * @var string means all tries at a question during an attempt by a user.
81 */
82 const ALL_TRIES = 'alltries';
83
dcd03928
TH
84 /** @var integer if this attempts is stored in the question_attempts table, the id of that row. */
85 protected $id = null;
86
87 /** @var integer|string the id of the question_usage_by_activity we belong to. */
88 protected $usageid;
89
90 /** @var integer the number used to identify this question_attempt within the usage. */
91 protected $slot = null;
92
93 /**
94 * @var question_behaviour the behaviour controlling this attempt.
95 * null until {@link start()} is called.
96 */
97 protected $behaviour = null;
98
99 /** @var question_definition the question this is an attempt at. */
100 protected $question;
101
1da821bb
TH
102 /** @var int which variant of the question to use. */
103 protected $variant;
104
4e3d8293
TH
105 /**
106 * @var float the maximum mark that can be scored at this question.
107 * Actually, this is only really a nominal maximum. It might be better thought
108 * of as the question weight.
109 */
dcd03928
TH
110 protected $maxmark;
111
112 /**
4e3d8293 113 * @var float the minimum fraction that can be scored at this question, so
dcd03928
TH
114 * the minimum mark is $this->minfraction * $this->maxmark.
115 */
116 protected $minfraction = null;
117
4e3d8293
TH
118 /**
119 * @var float the maximum fraction that can be scored at this question, so
120 * the maximum mark is $this->maxfraction * $this->maxmark.
121 */
122 protected $maxfraction = null;
123
dcd03928
TH
124 /**
125 * @var string plain text summary of the variant of the question the
126 * student saw. Intended for reporting purposes.
127 */
128 protected $questionsummary = null;
129
130 /**
131 * @var string plain text summary of the response the student gave.
132 * Intended for reporting purposes.
133 */
134 protected $responsesummary = null;
135
136 /**
137 * @var string plain text summary of the correct response to this question
138 * variant the student saw. The format should be similar to responsesummary.
139 * Intended for reporting purposes.
140 */
141 protected $rightanswer = null;
142
143 /** @var array of {@link question_attempt_step}s. The steps in this attempt. */
144 protected $steps = array();
145
0a606a2b
TH
146 /**
147 * @var question_attempt_step if, when we loaded the step from the DB, there was
148 * an autosaved step, we save a pointer to it here. (It is also added to the $steps array.)
149 */
150 protected $autosavedstep = null;
151
dcd03928
TH
152 /** @var boolean whether the user has flagged this attempt within the usage. */
153 protected $flagged = false;
154
155 /** @var question_usage_observer tracks changes to the useage this attempt is part of.*/
156 protected $observer;
157
158 /**#@+
159 * Constants used by the intereaction models to indicate whether the current
160 * pending step should be kept or discarded.
161 */
162 const KEEP = true;
163 const DISCARD = false;
164 /**#@-*/
165
166 /**
167 * Create a new {@link question_attempt}. Normally you should create question_attempts
168 * indirectly, by calling {@link question_usage_by_activity::add_question()}.
169 *
170 * @param question_definition $question the question this is an attempt at.
171 * @param int|string $usageid The id of the
172 * {@link question_usage_by_activity} we belong to. Used by {@link get_field_prefix()}.
173 * @param question_usage_observer $observer tracks changes to the useage this
174 * attempt is part of. (Optional, a {@link question_usage_null_observer} is
175 * used if one is not passed.
176 * @param number $maxmark the maximum grade for this question_attempt. If not
177 * passed, $question->defaultmark is used.
178 */
179 public function __construct(question_definition $question, $usageid,
180 question_usage_observer $observer = null, $maxmark = null) {
181 $this->question = $question;
182 $this->usageid = $usageid;
183 if (is_null($observer)) {
184 $observer = new question_usage_null_observer();
185 }
186 $this->observer = $observer;
187 if (!is_null($maxmark)) {
188 $this->maxmark = $maxmark;
189 } else {
190 $this->maxmark = $question->defaultmark;
191 }
192 }
193
f123d67f
TH
194 /**
195 * This method exists so that {@link question_attempt_with_restricted_history}
196 * can override it. You should not normally need to call it.
197 * @return question_attempt return ourself.
198 */
199 public function get_full_qa() {
200 return $this;
201 }
202
dcd03928
TH
203 /** @return question_definition the question this is an attempt at. */
204 public function get_question() {
205 return $this->question;
206 }
207
1da821bb
TH
208 /**
209 * Get the variant of the question being used in a given slot.
210 * @return int the variant number.
211 */
212 public function get_variant() {
213 return $this->variant;
214 }
215
dcd03928
TH
216 /**
217 * Set the number used to identify this question_attempt within the usage.
218 * For internal use only.
219 * @param int $slot
220 */
94815ccf 221 public function set_slot($slot) {
dcd03928
TH
222 $this->slot = $slot;
223 }
224
225 /** @return int the number used to identify this question_attempt within the usage. */
226 public function get_slot() {
227 return $this->slot;
228 }
229
230 /**
231 * @return int the id of row for this question_attempt, if it is stored in the
232 * database. null if not.
233 */
234 public function get_database_id() {
235 return $this->id;
236 }
237
238 /**
239 * For internal use only. Set the id of the corresponding database row.
240 * @param int $id the id of row for this question_attempt, if it is
241 * stored in the database.
242 */
243 public function set_database_id($id) {
244 $this->id = $id;
245 }
246
94815ccf
TH
247 /**
248 * You should almost certainly not call this method from your code. It is for
249 * internal use only.
250 * @param question_usage_observer that should be used to tracking changes made to this qa.
251 */
252 public function set_observer($observer) {
253 $this->observer = $observer;
254 }
255
dcd03928
TH
256 /** @return int|string the id of the {@link question_usage_by_activity} we belong to. */
257 public function get_usage_id() {
258 return $this->usageid;
259 }
260
261 /**
262 * Set the id of the {@link question_usage_by_activity} we belong to.
263 * For internal use only.
264 * @param int|string the new id.
265 */
266 public function set_usage_id($usageid) {
267 $this->usageid = $usageid;
268 }
269
270 /** @return string the name of the behaviour that is controlling this attempt. */
271 public function get_behaviour_name() {
272 return $this->behaviour->get_name();
273 }
274
275 /**
276 * For internal use only.
277 * @return question_behaviour the behaviour that is controlling this attempt.
278 */
279 public function get_behaviour() {
280 return $this->behaviour;
281 }
282
283 /**
284 * Set the flagged state of this question.
285 * @param bool $flagged the new state.
286 */
287 public function set_flagged($flagged) {
288 $this->flagged = $flagged;
289 $this->observer->notify_attempt_modified($this);
290 }
291
292 /** @return bool whether this question is currently flagged. */
293 public function is_flagged() {
294 return $this->flagged;
295 }
296
297 /**
298 * Get the name (in the sense a HTML name="" attribute, or a $_POST variable
299 * name) to use for the field that indicates whether this question is flagged.
300 *
301 * @return string The field name to use.
302 */
303 public function get_flag_field_name() {
304 return $this->get_control_field_name('flagged');
305 }
306
307 /**
308 * Get the name (in the sense a HTML name="" attribute, or a $_POST variable
309 * name) to use for a question_type variable belonging to this question_attempt.
310 *
311 * See the comment on {@link question_attempt_step} for an explanation of
312 * question type and behaviour variables.
313 *
314 * @param $varname The short form of the variable name.
315 * @return string The field name to use.
316 */
317 public function get_qt_field_name($varname) {
318 return $this->get_field_prefix() . $varname;
319 }
320
321 /**
322 * Get the name (in the sense a HTML name="" attribute, or a $_POST variable
323 * name) to use for a question_type variable belonging to this question_attempt.
324 *
325 * See the comment on {@link question_attempt_step} for an explanation of
326 * question type and behaviour variables.
327 *
328 * @param $varname The short form of the variable name.
329 * @return string The field name to use.
330 */
331 public function get_behaviour_field_name($varname) {
332 return $this->get_field_prefix() . '-' . $varname;
333 }
334
335 /**
336 * Get the name (in the sense a HTML name="" attribute, or a $_POST variable
337 * name) to use for a control variables belonging to this question_attempt.
338 *
339 * Examples are :sequencecheck and :flagged
340 *
341 * @param $varname The short form of the variable name.
342 * @return string The field name to use.
343 */
344 public function get_control_field_name($varname) {
345 return $this->get_field_prefix() . ':' . $varname;
346 }
347
348 /**
349 * Get the prefix added to variable names to give field names for this
350 * question attempt.
351 *
352 * You should not use this method directly. This is an implementation detail
353 * anyway, but if you must access it, use {@link question_usage_by_activity::get_field_prefix()}.
354 *
355 * @param $varname The short form of the variable name.
356 * @return string The field name to use.
357 */
358 public function get_field_prefix() {
359 return 'q' . $this->usageid . ':' . $this->slot . '_';
360 }
361
362 /**
363 * Get one of the steps in this attempt.
99caa248 364 *
f6579bea 365 * @param int $i the step number, which counts from 0.
dcd03928
TH
366 * @return question_attempt_step
367 */
368 public function get_step($i) {
369 if ($i < 0 || $i >= count($this->steps)) {
370 throw new coding_exception('Index out of bounds in question_attempt::get_step.');
371 }
372 return $this->steps[$i];
373 }
374
c7fbfe46
TH
375 /**
376 * Get the number of real steps in this attempt.
377 * This is put as a hidden field in the HTML, so that when we receive some
378 * data to process, then we can check that it came from the question
379 * in the state we are now it.
380 * @return int a number that summarises the current state of this question attempt.
381 */
382 public function get_sequence_check_count() {
383 $numrealsteps = $this->get_num_steps();
384 if ($this->has_autosaved_step()) {
385 $numrealsteps -= 1;
386 }
387 return $numrealsteps;
388 }
389
dcd03928
TH
390 /**
391 * Get the number of steps in this attempt.
392 * For internal/test code use only.
393 * @return int the number of steps we currently have.
394 */
395 public function get_num_steps() {
396 return count($this->steps);
397 }
398
399 /**
400 * Return the latest step in this question_attempt.
401 * For internal/test code use only.
402 * @return question_attempt_step
403 */
404 public function get_last_step() {
405 if (count($this->steps) == 0) {
406 return new question_null_step();
407 }
408 return end($this->steps);
409 }
410
0a606a2b
TH
411 /**
412 * @return boolean whether this question_attempt has autosaved data from
413 * some time in the past.
414 */
415 public function has_autosaved_step() {
416 return !is_null($this->autosavedstep);
417 }
418
dcd03928
TH
419 /**
420 * @return question_attempt_step_iterator for iterating over the steps in
421 * this attempt, in order.
422 */
423 public function get_step_iterator() {
424 return new question_attempt_step_iterator($this);
425 }
426
427 /**
428 * The same as {@link get_step_iterator()}. However, for a
429 * {@link question_attempt_with_restricted_history} this returns the full
430 * list of steps, while {@link get_step_iterator()} returns only the
431 * limited history.
432 * @return question_attempt_step_iterator for iterating over the steps in
433 * this attempt, in order.
434 */
435 public function get_full_step_iterator() {
436 return $this->get_step_iterator();
437 }
438
439 /**
440 * @return question_attempt_reverse_step_iterator for iterating over the steps in
441 * this attempt, in reverse order.
442 */
443 public function get_reverse_step_iterator() {
444 return new question_attempt_reverse_step_iterator($this);
445 }
446
447 /**
448 * Get the qt data from the latest step that has any qt data. Return $default
449 * array if it is no step has qt data.
450 *
451 * @param string $name the name of the variable to get.
452 * @param mixed default the value to return no step has qt data.
453 * (Optional, defaults to an empty array.)
454 * @return array|mixed the data, or $default if there is not any.
455 */
456 public function get_last_qt_data($default = array()) {
457 foreach ($this->get_reverse_step_iterator() as $step) {
458 $response = $step->get_qt_data();
459 if (!empty($response)) {
460 return $response;
461 }
462 }
463 return $default;
464 }
465
466 /**
467 * Get the last step with a particular question type varialbe set.
468 * @param string $name the name of the variable to get.
469 * @return question_attempt_step the last step, or a step with no variables
470 * if there was not a real step.
471 */
472 public function get_last_step_with_qt_var($name) {
473 foreach ($this->get_reverse_step_iterator() as $step) {
474 if ($step->has_qt_var($name)) {
475 return $step;
476 }
cc9fc649
HB
477 }
478 return new question_attempt_step_read_only();
479 }
480
481 /**
482 * Get the last step with a particular behaviour variable set.
483 * @param string $name the name of the variable to get.
484 * @return question_attempt_step the last step, or a step with no variables
485 * if there was not a real step.
486 */
487 public function get_last_step_with_behaviour_var($name) {
488 foreach ($this->get_reverse_step_iterator() as $step) {
489 if ($step->has_behaviour_var($name)) {
490 return $step;
491 }
dcd03928
TH
492 }
493 return new question_attempt_step_read_only();
494 }
495
496 /**
497 * Get the latest value of a particular question type variable. That is, get
498 * the value from the latest step that has it set. Return null if it is not
499 * set in any step.
500 *
501 * @param string $name the name of the variable to get.
502 * @param mixed default the value to return in the variable has never been set.
503 * (Optional, defaults to null.)
504 * @return mixed string value, or $default if it has never been set.
505 */
506 public function get_last_qt_var($name, $default = null) {
507 $step = $this->get_last_step_with_qt_var($name);
508 if ($step->has_qt_var($name)) {
509 return $step->get_qt_var($name);
510 } else {
511 return $default;
512 }
513 }
514
515 /**
516 * Get the latest set of files for a particular question type variable of
517 * type question_attempt::PARAM_FILES.
518 *
519 * @param string $name the name of the associated variable.
520 * @return array of {@link stored_files}.
521 */
522 public function get_last_qt_files($name, $contextid) {
523 foreach ($this->get_reverse_step_iterator() as $step) {
524 if ($step->has_qt_var($name)) {
525 return $step->get_qt_files($name, $contextid);
526 }
527 }
528 return array();
529 }
530
531 /**
532 * Get the URL of a file that belongs to a response variable of this
533 * question_attempt.
534 * @param stored_file $file the file to link to.
535 * @return string the URL of that file.
536 */
537 public function get_response_file_url(stored_file $file) {
538 return file_encode_url(new moodle_url('/pluginfile.php'), '/' . implode('/', array(
539 $file->get_contextid(),
540 $file->get_component(),
541 $file->get_filearea(),
542 $this->usageid,
543 $this->slot,
544 $file->get_itemid())) .
545 $file->get_filepath() . $file->get_filename(), true);
546 }
547
548 /**
549 * Prepare a draft file are for the files belonging the a response variable
550 * of this question attempt. The draft area is populated with the files from
551 * the most recent step having files.
552 *
553 * @param string $name the variable name the files belong to.
554 * @param int $contextid the id of the context the quba belongs to.
555 * @return int the draft itemid.
556 */
557 public function prepare_response_files_draft_itemid($name, $contextid) {
558 foreach ($this->get_reverse_step_iterator() as $step) {
559 if ($step->has_qt_var($name)) {
560 return $step->prepare_response_files_draft_itemid($name, $contextid);
561 }
562 }
563
564 // No files yet.
565 $draftid = 0; // Will be filled in by file_prepare_draft_area.
566 file_prepare_draft_area($draftid, $contextid, 'question', 'response_' . $name, null);
567 return $draftid;
568 }
569
570 /**
571 * Get the latest value of a particular behaviour variable. That is,
572 * get the value from the latest step that has it set. Return null if it is
573 * not set in any step.
574 *
575 * @param string $name the name of the variable to get.
576 * @param mixed default the value to return in the variable has never been set.
577 * (Optional, defaults to null.)
578 * @return mixed string value, or $default if it has never been set.
579 */
580 public function get_last_behaviour_var($name, $default = null) {
581 foreach ($this->get_reverse_step_iterator() as $step) {
582 if ($step->has_behaviour_var($name)) {
583 return $step->get_behaviour_var($name);
584 }
585 }
586 return $default;
587 }
588
589 /**
590 * Get the current state of this question attempt. That is, the state of the
591 * latest step.
592 * @return question_state
593 */
594 public function get_state() {
595 return $this->get_last_step()->get_state();
596 }
597
598 /**
599 * @param bool $showcorrectness Whether right/partial/wrong states should
600 * be distinguised.
601 * @return string A brief textual description of the current state.
602 */
603 public function get_state_string($showcorrectness) {
f8e28244
RK
604 // Special case when attempt is based on previous one, see MDL-31226.
605 if ($this->get_num_steps() == 1 && $this->get_state() == question_state::$complete) {
606 return get_string('notchanged', 'question');
607 }
dcd03928
TH
608 return $this->behaviour->get_state_string($showcorrectness);
609 }
610
97cdc1de
TH
611 /**
612 * @param bool $showcorrectness Whether right/partial/wrong states should
613 * be distinguised.
614 * @return string a CSS class name for the current state.
615 */
616 public function get_state_class($showcorrectness) {
617 return $this->get_state()->get_state_class($showcorrectness);
618 }
619
dcd03928
TH
620 /**
621 * @return int the timestamp of the most recent step in this question attempt.
622 */
623 public function get_last_action_time() {
624 return $this->get_last_step()->get_timecreated();
625 }
626
627 /**
628 * Get the current fraction of this question attempt. That is, the fraction
629 * of the latest step, or null if this question has not yet been graded.
630 * @return number the current fraction.
631 */
632 public function get_fraction() {
633 return $this->get_last_step()->get_fraction();
634 }
635
636 /** @return bool whether this question attempt has a non-zero maximum mark. */
637 public function has_marks() {
638 // Since grades are stored in the database as NUMBER(12,7).
639 return $this->maxmark >= 0.00000005;
640 }
641
642 /**
643 * @return number the current mark for this question.
644 * {@link get_fraction()} * {@link get_max_mark()}.
645 */
646 public function get_mark() {
647 return $this->fraction_to_mark($this->get_fraction());
648 }
649
650 /**
651 * This is used by the manual grading code, particularly in association with
652 * validation. If there is a mark submitted in the request, then use that,
653 * otherwise use the latest mark for this question.
654 * @return number the current mark for this question.
655 * {@link get_fraction()} * {@link get_max_mark()}.
656 */
657 public function get_current_manual_mark() {
658 $mark = $this->get_submitted_var($this->get_behaviour_field_name('mark'), question_attempt::PARAM_MARK);
659 if (is_null($mark)) {
660 return $this->get_mark();
661 } else {
662 return $mark;
663 }
664 }
665
666 /**
667 * @param number|null $fraction a fraction.
668 * @return number|null the corresponding mark.
669 */
670 public function fraction_to_mark($fraction) {
671 if (is_null($fraction)) {
672 return null;
673 }
674 return $fraction * $this->maxmark;
675 }
676
4e3d8293
TH
677 /**
678 * @return float the maximum mark possible for this question attempt.
679 * In fact, this is not strictly the maximum, becuase get_max_fraction may
680 * return a number greater than 1. It might be better to think of this as a
681 * question weight.
682 */
dcd03928
TH
683 public function get_max_mark() {
684 return $this->maxmark;
685 }
686
4e3d8293 687 /** @return float the maximum mark possible for this question attempt. */
dcd03928
TH
688 public function get_min_fraction() {
689 if (is_null($this->minfraction)) {
4e3d8293 690 throw new coding_exception('This question_attempt has not been started yet, the min fraction is not yet known.');
dcd03928
TH
691 }
692 return $this->minfraction;
693 }
694
4e3d8293
TH
695 /** @return float the maximum mark possible for this question attempt. */
696 public function get_max_fraction() {
697 if (is_null($this->maxfraction)) {
698 throw new coding_exception('This question_attempt has not been started yet, the max fraction is not yet known.');
699 }
700 return $this->maxfraction;
701 }
702
dcd03928
TH
703 /**
704 * The current mark, formatted to the stated number of decimal places. Uses
705 * {@link format_float()} to format floats according to the current locale.
706 * @param int $dp number of decimal places.
707 * @return string formatted mark.
708 */
709 public function format_mark($dp) {
710 return $this->format_fraction_as_mark($this->get_fraction(), $dp);
711 }
712
713 /**
714 * The current mark, formatted to the stated number of decimal places. Uses
715 * {@link format_float()} to format floats according to the current locale.
716 * @param int $dp number of decimal places.
717 * @return string formatted mark.
718 */
719 public function format_fraction_as_mark($fraction, $dp) {
720 return format_float($this->fraction_to_mark($fraction), $dp);
721 }
722
723 /**
724 * The maximum mark for this question attempt, formatted to the stated number
725 * of decimal places. Uses {@link format_float()} to format floats according
726 * to the current locale.
727 * @param int $dp number of decimal places.
728 * @return string formatted maximum mark.
729 */
730 public function format_max_mark($dp) {
731 return format_float($this->maxmark, $dp);
732 }
733
734 /**
735 * Return the hint that applies to the question in its current state, or null.
736 * @return question_hint|null
737 */
738 public function get_applicable_hint() {
739 return $this->behaviour->get_applicable_hint();
740 }
741
742 /**
743 * Produce a plain-text summary of what the user did during a step.
744 * @param question_attempt_step $step the step in quetsion.
745 * @return string a summary of what was done during that step.
746 */
747 public function summarise_action(question_attempt_step $step) {
748 return $this->behaviour->summarise_action($step);
749 }
750
f6579bea
TH
751 /**
752 * Return one of the bits of metadata for a this question attempt.
753 * @param string $name the name of the metadata variable to return.
754 * @return string the value of that metadata variable.
755 */
756 public function get_metadata($name) {
757 return $this->get_step(0)->get_metadata_var($name);
758 }
759
760 /**
761 * Set some metadata for this question attempt.
762 * @param string $name the name of the metadata variable to return.
763 * @param string $value the value to set that metadata variable to.
764 */
765 public function set_metadata($name, $value) {
766 $firststep = $this->get_step(0);
767 if (!$firststep->has_metadata_var($name)) {
768 $this->observer->notify_metadata_added($this, $name);
769 } else if ($value !== $firststep->get_metadata_var($name)) {
770 $this->observer->notify_metadata_modified($this, $name);
771 }
772 $firststep->set_metadata_var($name, $value);
773 }
774
dcd03928
TH
775 /**
776 * Helper function used by {@link rewrite_pluginfile_urls()} and
777 * {@link rewrite_response_pluginfile_urls()}.
778 * @return array ids that need to go into the file paths.
779 */
780 protected function extra_file_path_components() {
781 return array($this->get_usage_id(), $this->get_slot());
782 }
783
784 /**
785 * Calls {@link question_rewrite_question_urls()} with appropriate parameters
786 * for content belonging to this question.
787 * @param string $text the content to output.
788 * @param string $component the component name (normally 'question' or 'qtype_...')
789 * @param string $filearea the name of the file area.
790 * @param int $itemid the item id.
791 * @return srting the content with the URLs rewritten.
792 */
793 public function rewrite_pluginfile_urls($text, $component, $filearea, $itemid) {
794 return question_rewrite_question_urls($text, 'pluginfile.php',
795 $this->question->contextid, $component, $filearea,
796 $this->extra_file_path_components(), $itemid);
797 }
798
799 /**
800 * Calls {@link question_rewrite_question_urls()} with appropriate parameters
801 * for content belonging to responses to this question.
802 *
803 * @param string $text the text to update the URLs in.
804 * @param int $contextid the id of the context the quba belongs to.
805 * @param string $name the variable name the files belong to.
806 * @param question_attempt_step $step the step the response is coming from.
807 * @return srting the content with the URLs rewritten.
808 */
809 public function rewrite_response_pluginfile_urls($text, $contextid, $name,
810 question_attempt_step $step) {
811 return $step->rewrite_response_pluginfile_urls($text, $contextid, $name,
812 $this->extra_file_path_components());
813 }
814
815 /**
816 * Get the {@link core_question_renderer}, in collaboration with appropriate
817 * {@link qbehaviour_renderer} and {@link qtype_renderer} subclasses, to generate the
818 * HTML to display this question attempt in its current state.
819 * @param question_display_options $options controls how the question is rendered.
820 * @param string|null $number The question number to display.
821 * @return string HTML fragment representing the question.
822 */
823 public function render($options, $number, $page = null) {
824 if (is_null($page)) {
825 global $PAGE;
826 $page = $PAGE;
827 }
828 $qoutput = $page->get_renderer('core', 'question');
829 $qtoutput = $this->question->get_renderer($page);
830 return $this->behaviour->render($options, $number, $qoutput, $qtoutput);
831 }
832
833 /**
834 * Generate any bits of HTML that needs to go in the <head> tag when this question
835 * attempt is displayed in the body.
836 * @return string HTML fragment.
837 */
838 public function render_head_html($page = null) {
839 if (is_null($page)) {
840 global $PAGE;
841 $page = $PAGE;
842 }
843 // TODO go via behaviour.
844 return $this->question->get_renderer($page)->head_code($this) .
845 $this->behaviour->get_renderer($page)->head_code($this);
846 }
847
848 /**
849 * Like {@link render_question()} but displays the question at the past step
850 * indicated by $seq, rather than showing the latest step.
851 *
852 * @param int $seq the seq number of the past state to display.
853 * @param question_display_options $options controls how the question is rendered.
854 * @param string|null $number The question number to display. 'i' is a special
855 * value that gets displayed as Information. Null means no number is displayed.
856 * @return string HTML fragment representing the question.
857 */
858 public function render_at_step($seq, $options, $number, $preferredbehaviour) {
859 $restrictedqa = new question_attempt_with_restricted_history($this, $seq, $preferredbehaviour);
860 return $restrictedqa->render($options, $number);
861 }
862
863 /**
864 * Checks whether the users is allow to be served a particular file.
865 * @param question_display_options $options the options that control display of the question.
866 * @param string $component the name of the component we are serving files for.
867 * @param string $filearea the name of the file area.
868 * @param array $args the remaining bits of the file path.
869 * @param bool $forcedownload whether the user must be forced to download the file.
870 * @return bool true if the user can access this file.
871 */
872 public function check_file_access($options, $component, $filearea, $args, $forcedownload) {
873 return $this->behaviour->check_file_access($options, $component, $filearea, $args, $forcedownload);
874 }
875
876 /**
877 * Add a step to this question attempt.
878 * @param question_attempt_step $step the new step.
879 */
880 protected function add_step(question_attempt_step $step) {
881 $this->steps[] = $step;
882 end($this->steps);
883 $this->observer->notify_step_added($step, $this, key($this->steps));
884 }
885
0a606a2b
TH
886 /**
887 * Add an auto-saved step to this question attempt. We mark auto-saved steps by
888 * changing saving the step number with a - sign.
889 * @param question_attempt_step $step the new step.
890 */
891 protected function add_autosaved_step(question_attempt_step $step) {
892 $this->steps[] = $step;
893 $this->autosavedstep = $step;
894 end($this->steps);
895 $this->observer->notify_step_added($step, $this, -key($this->steps));
896 }
897
898 /**
899 * Discard any auto-saved data belonging to this question attempt.
900 */
901 public function discard_autosaved_step() {
902 if (!$this->has_autosaved_step()) {
903 return;
904 }
905
906 $autosaved = array_pop($this->steps);
907 $this->autosavedstep = null;
908 $this->observer->notify_step_deleted($autosaved, $this);
909 }
910
3d96b494
TH
911 /**
912 * If there is an autosaved step, convert it into a real save, so that it
913 * is preserved.
914 */
915 protected function convert_autosaved_step_to_real_step() {
916 if ($this->autosavedstep === null) {
917 return;
918 }
919
920 $laststep = end($this->steps);
921 if ($laststep !== $this->autosavedstep) {
922 throw new coding_exception('Cannot convert autosaved step to real step, since other steps have been added.');
923 }
924
925 $this->observer->notify_step_modified($this->autosavedstep, $this, key($this->steps));
926 $this->autosavedstep = null;
927 }
928
1da821bb
TH
929 /**
930 * Use a strategy to pick a variant.
931 * @param question_variant_selection_strategy $variantstrategy a strategy.
932 * @return int the selected variant.
933 */
934 public function select_variant(question_variant_selection_strategy $variantstrategy) {
935 return $variantstrategy->choose_variant($this->get_question()->get_num_variants(),
936 $this->get_question()->get_variants_selection_seed());
937 }
938
dcd03928
TH
939 /**
940 * Start this question attempt.
941 *
942 * You should not call this method directly. Call
943 * {@link question_usage_by_activity::start_question()} instead.
944 *
945 * @param string|question_behaviour $preferredbehaviour the name of the
946 * desired archetypal behaviour, or an actual model instance.
1da821bb
TH
947 * @param int $variant the variant of the question to start. Between 1 and
948 * $this->get_question()->get_num_variants() inclusive.
dcd03928
TH
949 * @param array $submitteddata optional, used when re-starting to keep the same initial state.
950 * @param int $timestamp optional, the timstamp to record for this action. Defaults to now.
951 * @param int $userid optional, the user to attribute this action to. Defaults to the current user.
94815ccf
TH
952 * @param int $existingstepid optional, if this step is going to replace an existing step
953 * (for example, during a regrade) this is the id of the previous step we are replacing.
dcd03928 954 */
1da821bb 955 public function start($preferredbehaviour, $variant, $submitteddata = array(),
94815ccf 956 $timestamp = null, $userid = null, $existingstepid = null) {
1da821bb 957
f6579bea
TH
958 if ($this->get_num_steps() > 0) {
959 throw new coding_exception('Cannot start a question that is already started.');
960 }
961
dcd03928 962 // Initialise the behaviour.
1da821bb 963 $this->variant = $variant;
dcd03928
TH
964 if (is_string($preferredbehaviour)) {
965 $this->behaviour =
966 $this->question->make_behaviour($this, $preferredbehaviour);
967 } else {
968 $class = get_class($preferredbehaviour);
969 $this->behaviour = new $class($this, $preferredbehaviour);
970 }
971
4e3d8293 972 // Record the minimum and maximum fractions.
dcd03928 973 $this->minfraction = $this->behaviour->get_min_fraction();
4e3d8293 974 $this->maxfraction = $this->behaviour->get_max_fraction();
dcd03928
TH
975
976 // Initialise the first step.
94815ccf 977 $firststep = new question_attempt_step($submitteddata, $timestamp, $userid, $existingstepid);
dcd03928 978 if ($submitteddata) {
f8e28244
RK
979 $firststep->set_state(question_state::$complete);
980 $this->behaviour->apply_attempt_state($firststep);
dcd03928 981 } else {
1da821bb 982 $this->behaviour->init_first_step($firststep, $variant);
dcd03928
TH
983 }
984 $this->add_step($firststep);
985
986 // Record questionline and correct answer.
987 $this->questionsummary = $this->behaviour->get_question_summary();
988 $this->rightanswer = $this->behaviour->get_right_answer_summary();
989 }
990
991 /**
992 * Start this question attempt, starting from the point that the previous
993 * attempt $oldqa had reached.
994 *
995 * You should not call this method directly. Call
996 * {@link question_usage_by_activity::start_question_based_on()} instead.
997 *
998 * @param question_attempt $oldqa a previous attempt at this quetsion that
999 * defines the starting point.
1000 */
1001 public function start_based_on(question_attempt $oldqa) {
1da821bb 1002 $this->start($oldqa->behaviour, $oldqa->get_variant(), $oldqa->get_resume_data());
dcd03928
TH
1003 }
1004
1005 /**
1006 * Used by {@link start_based_on()} to get the data needed to start a new
1007 * attempt from the point this attempt has go to.
1008 * @return array name => value pairs.
1009 */
1010 protected function get_resume_data() {
afb1b3d0
TH
1011 $resumedata = $this->behaviour->get_resume_data();
1012 foreach ($resumedata as $name => $value) {
1013 if ($value instanceof question_file_loader) {
1014 $resumedata[$name] = $value->get_question_file_saver();
1015 }
1016 }
1017 return $resumedata;
dcd03928
TH
1018 }
1019
1020 /**
1021 * Get a particular parameter from the current request. A wrapper round
1022 * {@link optional_param()}, except that the results is returned without
1023 * slashes.
1024 * @param string $name the paramter name.
1025 * @param int $type one of the standard PARAM_... constants, or one of the
1026 * special extra constands defined by this class.
1027 * @param array $postdata (optional, only inteded for testing use) take the
1028 * data from this array, instead of from $_POST.
1029 * @return mixed the requested value.
1030 */
1031 public function get_submitted_var($name, $type, $postdata = null) {
1032 switch ($type) {
1033 case self::PARAM_MARK:
61cca0b7 1034 // Special case to work around PARAM_FLOAT converting '' to 0.
2c76c894 1035 return question_utils::clean_param_mark($this->get_submitted_var($name, PARAM_RAW_TRIMMED, $postdata));
dcd03928
TH
1036
1037 case self::PARAM_FILES:
1038 return $this->process_response_files($name, $name, $postdata);
1039
2d2018ab
TH
1040 case self::PARAM_RAW_FILES:
1041 $var = $this->get_submitted_var($name, PARAM_RAW, $postdata);
dcd03928
TH
1042 return $this->process_response_files($name, $name . ':itemid', $postdata, $var);
1043
1044 default:
1045 if (is_null($postdata)) {
1046 $var = optional_param($name, null, $type);
1047 } else if (array_key_exists($name, $postdata)) {
1048 $var = clean_param($postdata[$name], $type);
1049 } else {
1050 $var = null;
1051 }
1052
1053 return $var;
1054 }
1055 }
1056
52b08f5f
NM
1057
1058 public function get_validation_message() {
1059
1060 if (!$this->manual_mark_format_is_ok()) {
1061 $errorclass = ' error';
1062 return html_writer::tag('span', get_string('manualgradeinvalidformat', 'question'),
1063 array('class' => 'error')) . html_writer::empty_tag('br');
1064 }
1065 $currentmark = $this->get_current_manual_mark();
1066 $maxmark = $this->get_max_mark();
1067 if ($currentmark > $maxmark * $this->get_max_fraction() || $currentmark < $maxmark * $this->get_min_fraction()) {
1068 $errorclass = ' error';
1069 return html_writer::tag('span', get_string('manualgradeoutofrange', 'question'),
1070 array('class' => 'error')) . html_writer::empty_tag('br');
1071 }
1072
1073 return '';
1074
1075 }
1076
1077 /**
1078 * Validates that the manual mark parameter is a float.
1079 * @return bool.
1080 */
1081 public function manual_mark_format_is_ok() {
1082 $val = $this->get_submitted_var($this->get_behaviour_field_name('mark'), PARAM_RAW_TRIMMED);
1083
1084 // If it is empy, we get null (it is always the case on start)
1085 if ($val===null) {
1086 return true;
1087 }
1088 $mark = unformat_float($val, true);
1089
1090 return is_float($mark);
1091 }
1092
dcd03928
TH
1093 /**
1094 * Handle a submitted variable representing uploaded files.
1095 * @param string $name the field name.
1096 * @param string $draftidname the field name holding the draft file area id.
1097 * @param array $postdata (optional, only inteded for testing use) take the
1098 * data from this array, instead of from $_POST. At the moment, this
1099 * behaves as if there were no files.
1100 * @param string $text optional reponse text.
1101 * @return question_file_saver that can be used to save the files later.
1102 */
1103 protected function process_response_files($name, $draftidname, $postdata = null, $text = null) {
1104 if ($postdata) {
afb1b3d0
TH
1105 // For simulated posts, get the draft itemid from there.
1106 $draftitemid = $this->get_submitted_var($draftidname, PARAM_INT, $postdata);
1107 } else {
1108 $draftitemid = file_get_submitted_draft_itemid($draftidname);
dcd03928
TH
1109 }
1110
dcd03928
TH
1111 if (!$draftitemid) {
1112 return null;
1113 }
1114
1115 return new question_file_saver($draftitemid, 'question', 'response_' .
1116 str_replace($this->get_field_prefix(), '', $name), $text);
1117 }
1118
1119 /**
1120 * Get any data from the request that matches the list of expected params.
1121 * @param array $expected variable name => PARAM_... constant.
1122 * @param string $extraprefix '-' or ''.
1123 * @return array name => value.
1124 */
1125 protected function get_expected_data($expected, $postdata, $extraprefix) {
1126 $submitteddata = array();
1127 foreach ($expected as $name => $type) {
1128 $value = $this->get_submitted_var(
1129 $this->get_field_prefix() . $extraprefix . $name, $type, $postdata);
1130 if (!is_null($value)) {
1131 $submitteddata[$extraprefix . $name] = $value;
1132 }
1133 }
1134 return $submitteddata;
1135 }
1136
1137 /**
1138 * Get all the submitted question type data for this question, whithout checking
1139 * that it is valid or cleaning it in any way.
1140 * @return array name => value.
1141 */
df7d175d 1142 public function get_all_submitted_qt_vars($postdata) {
dcd03928
TH
1143 if (is_null($postdata)) {
1144 $postdata = $_POST;
1145 }
1146
03cefcc9 1147 $pattern = '/^' . preg_quote($this->get_field_prefix(), '/') . '[^-:]/';
dcd03928
TH
1148 $prefixlen = strlen($this->get_field_prefix());
1149
1150 $submitteddata = array();
df7d175d 1151 foreach ($postdata as $name => $value) {
dcd03928
TH
1152 if (preg_match($pattern, $name)) {
1153 $submitteddata[substr($name, $prefixlen)] = $value;
1154 }
1155 }
1156
1157 return $submitteddata;
1158 }
1159
1160 /**
1161 * Get all the sumbitted data belonging to this question attempt from the
1162 * current request.
1163 * @param array $postdata (optional, only inteded for testing use) take the
1164 * data from this array, instead of from $_POST.
1165 * @return array name => value pairs that could be passed to {@link process_action()}.
1166 */
1167 public function get_submitted_data($postdata = null) {
1168 $submitteddata = $this->get_expected_data(
1169 $this->behaviour->get_expected_data(), $postdata, '-');
1170
1171 $expected = $this->behaviour->get_expected_qt_data();
1172 if ($expected === self::USE_RAW_DATA) {
1173 $submitteddata += $this->get_all_submitted_qt_vars($postdata);
1174 } else {
1175 $submitteddata += $this->get_expected_data($expected, $postdata, '');
1176 }
1177 return $submitteddata;
1178 }
1179
1180 /**
1181 * Get a set of response data for this question attempt that would get the
da22c012
K
1182 * best possible mark. If it is not possible to compute a correct
1183 * response, this method should return null.
1184 * @return array|null name => value pairs that could be passed to {@link process_action()}.
dcd03928
TH
1185 */
1186 public function get_correct_response() {
1187 $response = $this->question->get_correct_response();
da22c012
K
1188 if (is_null($response)) {
1189 return null;
1190 }
dcd03928
TH
1191 $imvars = $this->behaviour->get_correct_response();
1192 foreach ($imvars as $name => $value) {
1193 $response['-' . $name] = $value;
1194 }
1195 return $response;
1196 }
1197
1198 /**
1199 * Change the quetsion summary. Note, that this is almost never necessary.
1200 * This method was only added to work around a limitation of the Opaque
1201 * protocol, which only sends questionLine at the end of an attempt.
1202 * @param $questionsummary the new summary to set.
1203 */
1204 public function set_question_summary($questionsummary) {
1205 $this->questionsummary = $questionsummary;
1206 $this->observer->notify_attempt_modified($this);
1207 }
1208
1209 /**
1210 * @return string a simple textual summary of the question that was asked.
1211 */
1212 public function get_question_summary() {
1213 return $this->questionsummary;
1214 }
1215
1216 /**
1217 * @return string a simple textual summary of response given.
1218 */
1219 public function get_response_summary() {
1220 return $this->responsesummary;
1221 }
1222
1223 /**
1224 * @return string a simple textual summary of the correct resonse.
1225 */
1226 public function get_right_answer_summary() {
1227 return $this->rightanswer;
1228 }
1229
fd7a8af5
TH
1230 /**
1231 * Whether this attempt at this question could be completed just by the
1232 * student interacting with the question, before {@link finish()} is called.
1233 *
1234 * @return boolean whether this attempt can finish naturally.
1235 */
1236 public function can_finish_during_attempt() {
1237 return $this->behaviour->can_finish_during_attempt();
1238 }
1239
dcd03928
TH
1240 /**
1241 * Perform the action described by $submitteddata.
1242 * @param array $submitteddata the submitted data the determines the action.
1243 * @param int $timestamp the time to record for the action. (If not given, use now.)
0a606a2b
TH
1244 * @param int $userid the user to attribute the action to. (If not given, use the current user.)
1245 * @param int $existingstepid used by the regrade code.
dcd03928 1246 */
94815ccf
TH
1247 public function process_action($submitteddata, $timestamp = null, $userid = null, $existingstepid = null) {
1248 $pendingstep = new question_attempt_pending_step($submitteddata, $timestamp, $userid, $existingstepid);
0a606a2b 1249 $this->discard_autosaved_step();
dcd03928
TH
1250 if ($this->behaviour->process_action($pendingstep) == self::KEEP) {
1251 $this->add_step($pendingstep);
1252 if ($pendingstep->response_summary_changed()) {
1253 $this->responsesummary = $pendingstep->get_new_response_summary();
1254 }
a8de8667
TH
1255 if ($pendingstep->variant_number_changed()) {
1256 $this->variant = $pendingstep->get_new_variant_number();
1257 }
dcd03928
TH
1258 }
1259 }
1260
0a606a2b
TH
1261 /**
1262 * Process an autosave.
1263 * @param array $submitteddata the submitted data the determines the action.
1264 * @param int $timestamp the time to record for the action. (If not given, use now.)
1265 * @param int $userid the user to attribute the action to. (If not given, use the current user.)
1266 * @return bool whether anything was saved.
1267 */
1268 public function process_autosave($submitteddata, $timestamp = null, $userid = null) {
1269 $pendingstep = new question_attempt_pending_step($submitteddata, $timestamp, $userid);
1270 if ($this->behaviour->process_autosave($pendingstep) == self::KEEP) {
1271 $this->add_autosaved_step($pendingstep);
1272 return true;
1273 }
1274 return false;
1275 }
1276
dcd03928
TH
1277 /**
1278 * Perform a finish action on this question attempt. This corresponds to an
1279 * external finish action, for example the user pressing Submit all and finish
1280 * in the quiz, rather than using one of the controls that is part of the
1281 * question.
1282 *
1283 * @param int $timestamp the time to record for the action. (If not given, use now.)
1284 * @param int $userid the user to attribute the aciton to. (If not given, use the current user.)
1285 */
1286 public function finish($timestamp = null, $userid = null) {
3d96b494 1287 $this->convert_autosaved_step_to_real_step();
dcd03928
TH
1288 $this->process_action(array('-finish' => 1), $timestamp, $userid);
1289 }
1290
1291 /**
1292 * Perform a regrade. This replays all the actions from $oldqa into this
1293 * attempt.
1294 * @param question_attempt $oldqa the attempt to regrade.
1295 * @param bool $finished whether the question attempt should be forced to be finished
1296 * after the regrade, or whether it may still be in progress (default false).
1297 */
1298 public function regrade(question_attempt $oldqa, $finished) {
1299 $first = true;
1300 foreach ($oldqa->get_step_iterator() as $step) {
94815ccf 1301 $this->observer->notify_step_deleted($step, $this);
9212fe7a 1302
dcd03928 1303 if ($first) {
9212fe7a 1304 // First step of the attempt.
dcd03928 1305 $first = false;
1da821bb 1306 $this->start($oldqa->behaviour, $oldqa->get_variant(), $step->get_all_data(),
94815ccf 1307 $step->get_timecreated(), $step->get_user_id(), $step->get_id());
9212fe7a
TH
1308
1309 } else if ($step->has_behaviour_var('finish') && count($step->get_submitted_data()) > 1) {
1310 // This case relates to MDL-32062. The upgrade code from 2.0
1311 // generates attempts where the final submit of the question
1312 // data, and the finish action, are in the same step. The system
1313 // cannot cope with that, so convert the single old step into
1314 // two new steps.
1315 $submitteddata = $step->get_submitted_data();
1316 unset($submitteddata['-finish']);
1317 $this->process_action($submitteddata,
1318 $step->get_timecreated(), $step->get_user_id(), $step->get_id());
1319 $this->finish($step->get_timecreated(), $step->get_user_id());
1320
dcd03928 1321 } else {
9212fe7a 1322 // This is the normal case. Replay the next step of the attempt.
dcd03928 1323 $this->process_action($step->get_submitted_data(),
94815ccf 1324 $step->get_timecreated(), $step->get_user_id(), $step->get_id());
dcd03928
TH
1325 }
1326 }
9212fe7a 1327
dcd03928
TH
1328 if ($finished) {
1329 $this->finish();
1330 }
1331 }
1332
f6579bea
TH
1333 /**
1334 * Change the max mark for this question_attempt.
1335 * @param float $maxmark the new max mark.
1336 */
1337 public function set_max_mark($maxmark) {
1338 $this->maxmark = $maxmark;
1339 $this->observer->notify_attempt_modified($this);
1340 }
1341
dcd03928
TH
1342 /**
1343 * Perform a manual grading action on this attempt.
53b8e256
TH
1344 * @param string $comment the comment being added.
1345 * @param float $mark the new mark. If null, then only a comment is added.
1346 * @param int $commentformat the FORMAT_... for $comment. Must be given.
dcd03928
TH
1347 * @param int $timestamp the time to record for the action. (If not given, use now.)
1348 * @param int $userid the user to attribute the aciton to. (If not given, use the current user.)
dcd03928 1349 */
53b8e256 1350 public function manual_grade($comment, $mark, $commentformat = null, $timestamp = null, $userid = null) {
dcd03928 1351 $submitteddata = array('-comment' => $comment);
53b8e256
TH
1352 if (is_null($commentformat)) {
1353 debugging('You should pass $commentformat to manual_grade.', DEBUG_DEVELOPER);
1354 $commentformat = FORMAT_HTML;
1355 }
1356 $submitteddata['-commentformat'] = $commentformat;
dcd03928
TH
1357 if (!is_null($mark)) {
1358 $submitteddata['-mark'] = $mark;
1359 $submitteddata['-maxmark'] = $this->maxmark;
1360 }
1361 $this->process_action($submitteddata, $timestamp, $userid);
1362 }
1363
1364 /** @return bool Whether this question attempt has had a manual comment added. */
1365 public function has_manual_comment() {
1366 foreach ($this->steps as $step) {
1367 if ($step->has_behaviour_var('comment')) {
1368 return true;
1369 }
1370 }
1371 return false;
1372 }
1373
1374 /**
1375 * @return array(string, int) the most recent manual comment that was added
1376 * to this question, and the FORMAT_... it is.
1377 */
1378 public function get_manual_comment() {
1379 foreach ($this->get_reverse_step_iterator() as $step) {
1380 if ($step->has_behaviour_var('comment')) {
1381 return array($step->get_behaviour_var('comment'),
1382 $step->get_behaviour_var('commentformat'));
1383 }
1384 }
1385 return array(null, null);
1386 }
1387
1eb470fc
TH
1388 /**
1389 * This is used by the manual grading code, particularly in association with
1390 * validation. If there is a comment submitted in the request, then use that,
1391 * otherwise use the latest comment for this question.
1392 * @return number the current mark for this question.
1393 * {@link get_fraction()} * {@link get_max_mark()}.
1394 */
1395 public function get_current_manual_comment() {
1396 $comment = $this->get_submitted_var($this->get_behaviour_field_name('comment'), PARAM_RAW);
1397 if (is_null($comment)) {
1398 return $this->get_manual_comment();
1399 } else {
1400 $commentformat = $this->get_submitted_var(
1401 $this->get_behaviour_field_name('commentformat'), PARAM_INT);
1402 if ($commentformat === null) {
1403 $commentformat = FORMAT_HTML;
1404 }
1405 return array($comment, $commentformat);
1406 }
1407 }
1408
dcd03928 1409 /**
038014c4 1410 * Break down a student response by sub part and classification. See also {@link question::classify_response}.
d50b05e6
JP
1411 * Used for response analysis.
1412 *
038014c4
JP
1413 * @param string $whichtries which tries to analyse for response analysis. Will be one of
1414 * question_attempt::FIRST_TRY, LAST_TRY or ALL_TRIES.
1415 * Defaults to question_attempt::LAST_TRY.
1416 * @return (question_classified_response|array)[] If $whichtries is question_attempt::FIRST_TRY or LAST_TRY index is subpartid
1417 * and values are question_classified_response instances.
1418 * If $whichtries is question_attempt::ALL_TRIES then first key is submitted response no
1419 * and the second key is subpartid.
dcd03928 1420 */
038014c4
JP
1421 public function classify_response($whichtries = self::LAST_TRY) {
1422 return $this->behaviour->classify_response($whichtries);
dcd03928
TH
1423 }
1424
1425 /**
1426 * Create a question_attempt_step from records loaded from the database.
1427 *
1428 * For internal use only.
1429 *
35d5f1c2 1430 * @param Iterator $records Raw records loaded from the database.
dcd03928 1431 * @param int $questionattemptid The id of the question_attempt to extract.
94815ccf 1432 * @return question_attempt The newly constructed question_attempt.
dcd03928 1433 */
35d5f1c2 1434 public static function load_from_records($records, $questionattemptid,
dcd03928 1435 question_usage_observer $observer, $preferredbehaviour) {
35d5f1c2 1436 $record = $records->current();
dcd03928 1437 while ($record->questionattemptid != $questionattemptid) {
35d5f1c2
TH
1438 $record = $records->next();
1439 if (!$records->valid()) {
f4fe3968 1440 throw new coding_exception("Question attempt {$questionattemptid} not found in the database.");
dcd03928 1441 }
35d5f1c2 1442 $record = $records->current();
dcd03928
TH
1443 }
1444
1445 try {
1446 $question = question_bank::load_question($record->questionid);
1447 } catch (Exception $e) {
1448 // The question must have been deleted somehow. Create a missing
1449 // question to use in its place.
1450 $question = question_bank::get_qtype('missingtype')->make_deleted_instance(
1451 $record->questionid, $record->maxmark + 0);
1452 }
1453
1454 $qa = new question_attempt($question, $record->questionusageid,
1455 null, $record->maxmark + 0);
1456 $qa->set_database_id($record->questionattemptid);
94815ccf 1457 $qa->set_slot($record->slot);
1da821bb 1458 $qa->variant = $record->variant + 0;
dcd03928 1459 $qa->minfraction = $record->minfraction + 0;
4e3d8293 1460 $qa->maxfraction = $record->maxfraction + 0;
dcd03928
TH
1461 $qa->set_flagged($record->flagged);
1462 $qa->questionsummary = $record->questionsummary;
1463 $qa->rightanswer = $record->rightanswer;
1464 $qa->responsesummary = $record->responsesummary;
1465 $qa->timemodified = $record->timemodified;
1466
1467 $qa->behaviour = question_engine::make_behaviour(
1468 $record->behaviour, $qa, $preferredbehaviour);
0a606a2b 1469 $qa->observer = $observer;
dcd03928 1470
dd7aa583
TH
1471 // If attemptstepid is null (which should not happen, but has happened
1472 // due to corrupt data, see MDL-34251) then the current pointer in $records
1473 // will not be advanced in the while loop below, and we get stuck in an
1474 // infinite loop, since this method is supposed to always consume at
1475 // least one record. Therefore, in this case, advance the record here.
1476 if (is_null($record->attemptstepid)) {
1477 $records->next();
1478 }
1479
dcd03928 1480 $i = 0;
0a606a2b
TH
1481 $autosavedstep = null;
1482 $autosavedsequencenumber = null;
dcd03928 1483 while ($record && $record->questionattemptid == $questionattemptid && !is_null($record->attemptstepid)) {
0a606a2b 1484 $sequencenumber = $record->sequencenumber;
dc1ee5cb 1485 $nextstep = question_attempt_step::load_from_records($records, $record->attemptstepid, $qa->get_question()->get_type_name());
0a606a2b
TH
1486
1487 if ($sequencenumber < 0) {
1488 if (!$autosavedstep) {
1489 $autosavedstep = $nextstep;
1490 $autosavedsequencenumber = -$sequencenumber;
1491 } else {
1492 // Old redundant data. Mark it for deletion.
1493 $qa->observer->notify_step_deleted($nextstep, $qa);
1494 }
1495 } else {
1496 $qa->steps[$i] = $nextstep;
1497 if ($i == 0) {
1498 $question->apply_attempt_state($qa->steps[0]);
1499 }
1500 $i++;
dcd03928 1501 }
0a606a2b 1502
35d5f1c2
TH
1503 if ($records->valid()) {
1504 $record = $records->current();
1505 } else {
1506 $record = false;
1507 }
dcd03928
TH
1508 }
1509
0a606a2b
TH
1510 if ($autosavedstep) {
1511 if ($autosavedsequencenumber >= $i) {
1512 $qa->autosavedstep = $autosavedstep;
1513 $qa->steps[$i] = $qa->autosavedstep;
1514 } else {
1515 $qa->observer->notify_step_deleted($autosavedstep, $qa);
1516 }
1517 }
dcd03928
TH
1518
1519 return $qa;
1520 }
99caa248
JP
1521
1522 /**
1523 * Allow access to steps with responses submitted by students for grading in a question attempt.
1524 *
1525 * @return question_attempt_steps_with_submitted_response_iterator to access all steps with submitted data for questions that
1526 * allow multiple submissions that count towards grade, per attempt.
1527 */
1528 public function get_steps_with_submitted_response_iterator() {
1529 return new question_attempt_steps_with_submitted_response_iterator($this);
1530 }
dcd03928
TH
1531}
1532
1533
1534/**
1535 * This subclass of question_attempt pretends that only part of the step history
1536 * exists. It is used for rendering the question in past states.
1537 *
1538 * All methods that try to modify the question_attempt throw exceptions.
1539 *
1540 * @copyright 2010 The Open University
1541 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1542 */
1543class question_attempt_with_restricted_history extends question_attempt {
1544 /**
1545 * @var question_attempt the underlying question_attempt.
1546 */
1547 protected $baseqa;
1548
1549 /**
1550 * Create a question_attempt_with_restricted_history
1551 * @param question_attempt $baseqa The question_attempt to make a restricted version of.
1552 * @param int $lastseq the index of the last step to include.
1553 * @param string $preferredbehaviour the preferred behaviour. It is slightly
1554 * annoyting that this needs to be passed, but unavoidable for now.
1555 */
1556 public function __construct(question_attempt $baseqa, $lastseq, $preferredbehaviour) {
f123d67f
TH
1557 $this->baseqa = $baseqa->get_full_qa();
1558
1559 if ($lastseq < 0 || $lastseq >= $this->baseqa->get_num_steps()) {
1560 throw new coding_exception('$lastseq out of range', $lastseq);
dcd03928
TH
1561 }
1562
f123d67f 1563 $this->steps = array_slice($this->baseqa->steps, 0, $lastseq + 1);
dcd03928
TH
1564 $this->observer = new question_usage_null_observer();
1565
1566 // This should be a straight copy of all the remaining fields.
f123d67f
TH
1567 $this->id = $this->baseqa->id;
1568 $this->usageid = $this->baseqa->usageid;
1569 $this->slot = $this->baseqa->slot;
1570 $this->question = $this->baseqa->question;
1571 $this->maxmark = $this->baseqa->maxmark;
1572 $this->minfraction = $this->baseqa->minfraction;
4e3d8293 1573 $this->maxfraction = $this->baseqa->maxfraction;
f123d67f
TH
1574 $this->questionsummary = $this->baseqa->questionsummary;
1575 $this->responsesummary = $this->baseqa->responsesummary;
1576 $this->rightanswer = $this->baseqa->rightanswer;
1577 $this->flagged = $this->baseqa->flagged;
dcd03928
TH
1578
1579 // Except behaviour, where we need to create a new one.
1580 $this->behaviour = question_engine::make_behaviour(
f123d67f
TH
1581 $this->baseqa->get_behaviour_name(), $this, $preferredbehaviour);
1582 }
1583
1584 public function get_full_qa() {
1585 return $this->baseqa;
dcd03928
TH
1586 }
1587
1588 public function get_full_step_iterator() {
1589 return $this->baseqa->get_step_iterator();
1590 }
1591
1592 protected function add_step(question_attempt_step $step) {
1593 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1594 }
072db71c 1595 public function process_action($submitteddata, $timestamp = null, $userid = null, $existingstepid = null) {
dcd03928
TH
1596 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1597 }
072db71c 1598 public function start($preferredbehaviour, $variant, $submitteddata = array(), $timestamp = null, $userid = null, $existingstepid = null) {
dcd03928
TH
1599 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1600 }
1601
1602 public function set_database_id($id) {
1603 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1604 }
1605 public function set_flagged($flagged) {
1606 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1607 }
94815ccf 1608 public function set_slot($slot) {
dcd03928
TH
1609 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1610 }
1611 public function set_question_summary($questionsummary) {
1612 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1613 }
1614 public function set_usage_id($usageid) {
1615 coding_exception('Cannot modify a question_attempt_with_restricted_history.');
1616 }
1617}
1618
1619
1620/**
1621 * A class abstracting access to the {@link question_attempt::$states} array.
1622 *
1623 * This is actively linked to question_attempt. If you add an new step
1624 * mid-iteration, then it will be included.
1625 *
1626 * @copyright 2009 The Open University
1627 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1628 */
1629class question_attempt_step_iterator implements Iterator, ArrayAccess {
1630 /** @var question_attempt the question_attempt being iterated over. */
1631 protected $qa;
1632 /** @var integer records the current position in the iteration. */
1633 protected $i;
1634
1635 /**
1636 * Do not call this constructor directly.
1637 * Use {@link question_attempt::get_step_iterator()}.
1638 * @param question_attempt $qa the attempt to iterate over.
1639 */
1640 public function __construct(question_attempt $qa) {
1641 $this->qa = $qa;
1642 $this->rewind();
1643 }
1644
1645 /** @return question_attempt_step */
1646 public function current() {
1647 return $this->offsetGet($this->i);
1648 }
1649 /** @return int */
1650 public function key() {
1651 return $this->i;
1652 }
1653 public function next() {
1654 ++$this->i;
1655 }
1656 public function rewind() {
1657 $this->i = 0;
1658 }
1659 /** @return bool */
1660 public function valid() {
1661 return $this->offsetExists($this->i);
1662 }
1663
1664 /** @return bool */
1665 public function offsetExists($i) {
1666 return $i >= 0 && $i < $this->qa->get_num_steps();
1667 }
1668 /** @return question_attempt_step */
1669 public function offsetGet($i) {
1670 return $this->qa->get_step($i);
1671 }
1672 public function offsetSet($offset, $value) {
1673 throw new coding_exception('You are only allowed read-only access to question_attempt::states through a question_attempt_step_iterator. Cannot set.');
1674 }
1675 public function offsetUnset($offset) {
1676 throw new coding_exception('You are only allowed read-only access to question_attempt::states through a question_attempt_step_iterator. Cannot unset.');
1677 }
1678}
1679
1680
1681/**
1682 * A variant of {@link question_attempt_step_iterator} that iterates through the
1683 * steps in reverse order.
1684 *
1685 * @copyright 2009 The Open University
1686 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1687 */
1688class question_attempt_reverse_step_iterator extends question_attempt_step_iterator {
1689 public function next() {
1690 --$this->i;
1691 }
1692
1693 public function rewind() {
1694 $this->i = $this->qa->get_num_steps() - 1;
1695 }
1696}
99caa248
JP
1697
1698/**
1699 * A variant of {@link question_attempt_step_iterator} that iterates through the
1700 * steps with submitted tries.
1701 *
1702 * @copyright 2014 The Open University
1703 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1704 */
1705class question_attempt_steps_with_submitted_response_iterator extends question_attempt_step_iterator implements Countable {
1706
1707 /** @var question_attempt the question_attempt being iterated over. */
1708 protected $qa;
1709
1710 /** @var integer records the current position in the iteration. */
1711 protected $submittedresponseno;
1712
1713 /**
1714 * Index is the submitted response number and value is the step no.
1715 *
1716 * @var int[]
1717 */
1718 protected $stepswithsubmittedresponses;
1719
1720 /**
1721 * Do not call this constructor directly.
1722 * Use {@link question_attempt::get_submission_step_iterator()}.
1723 * @param question_attempt $qa the attempt to iterate over.
1724 */
1725 public function __construct(question_attempt $qa) {
1726 $this->qa = $qa;
1727 $this->find_steps_with_submitted_response();
1728 $this->rewind();
1729 }
1730
1731 /**
1732 * Find the step nos in which a student has submitted a response. Including any step with a response that is saved before
1733 * the question attempt finishes.
1734 *
1735 * Called from constructor, should not be called from elsewhere.
1736 *
1737 */
1738 protected function find_steps_with_submitted_response() {
1739 $stepnos = array();
1740 $lastsavedstep = null;
1741 foreach ($this->qa->get_step_iterator() as $stepno => $step) {
1742 if ($this->qa->get_behaviour()->step_has_a_submitted_response($step)) {
1743 $stepnos[] = $stepno;
1744 $lastsavedstep = null;
1745 } else {
1746 $qtdata = $step->get_qt_data();
1747 if (count($qtdata)) {
1748 $lastsavedstep = $stepno;
1749 }
1750 }
1751 }
1752
1753 if (!is_null($lastsavedstep)) {
1754 $stepnos[] = $lastsavedstep;
1755 }
1756 if (empty($stepnos)) {
1757 $this->stepswithsubmittedresponses = array();
1758 } else {
1759 // Re-index array so index starts with 1.
1760 $this->stepswithsubmittedresponses = array_combine(range(1, count($stepnos)), $stepnos);
1761 }
1762 }
1763
1764 /** @return question_attempt_step */
1765 public function current() {
1766 return $this->offsetGet($this->submittedresponseno);
1767 }
1768 /** @return int */
1769 public function key() {
1770 return $this->submittedresponseno;
1771 }
1772 public function next() {
1773 ++$this->submittedresponseno;
1774 }
1775 public function rewind() {
1776 $this->submittedresponseno = 1;
1777 }
1778 /** @return bool */
1779 public function valid() {
038014c4 1780 return $this->submittedresponseno >= 1 && $this->submittedresponseno <= count($this->stepswithsubmittedresponses);
99caa248
JP
1781 }
1782
1783 /**
1784 * @param int $submittedresponseno
1785 * @return bool
1786 */
1787 public function offsetExists($submittedresponseno) {
1788 return $submittedresponseno >= 1;
1789 }
1790
1791 /**
1792 * @param int $submittedresponseno
1793 * @return question_attempt_step
1794 */
1795 public function offsetGet($submittedresponseno) {
1796 if ($submittedresponseno > count($this->stepswithsubmittedresponses)) {
1797 return null;
1798 } else {
1799 return $this->qa->get_step($this->step_no_for_try($submittedresponseno));
1800 }
1801 }
1802
1803 /**
1804 * @return int the count of steps with tries.
1805 */
1806 public function count() {
1807 return count($this->stepswithsubmittedresponses);
1808 }
1809
1810 /**
1811 * @param int $submittedresponseno
1812 * @throws coding_exception
1813 * @return int|null the step number or null if there is no such submitted response.
1814 */
1815 public function step_no_for_try($submittedresponseno) {
1816 if (isset($this->stepswithsubmittedresponses[$submittedresponseno])) {
1817 return $this->stepswithsubmittedresponses[$submittedresponseno];
1818 } else if ($submittedresponseno > count($this->stepswithsubmittedresponses)) {
1819 return null;
1820 } else {
1821 throw new coding_exception('Try number not found. It should be 1 or more.');
1822 }
1823 }
1824
1825 public function offsetSet($offset, $value) {
1826 throw new coding_exception('You are only allowed read-only access to question_attempt::states '.
1827 'through a question_attempt_step_iterator. Cannot set.');
1828 }
1829 public function offsetUnset($offset) {
1830 throw new coding_exception('You are only allowed read-only access to question_attempt::states '.
1831 'through a question_attempt_step_iterator. Cannot unset.');
1832 }
1833
1834}