Merge branch 'MDL-66463-master' of git://github.com/ferranrecio/moodle
[moodle.git] / mod / quiz / attemptlib.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  * Back-end code for handling data about quizzes and the current user's attempt.
19  *
20  * There are classes for loading all the information about a quiz and attempts,
21  * and for displaying the navigation panel.
22  *
23  * @package   mod_quiz
24  * @copyright 2008 onwards Tim Hunt
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
29 defined('MOODLE_INTERNAL') || die();
32 /**
33  * Class for quiz exceptions. Just saves a couple of arguments on the
34  * constructor for a moodle_exception.
35  *
36  * @copyright 2008 Tim Hunt
37  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  * @since     Moodle 2.0
39  */
40 class moodle_quiz_exception extends moodle_exception {
41     public function __construct($quizobj, $errorcode, $a = null, $link = '', $debuginfo = null) {
42         if (!$link) {
43             $link = $quizobj->view_url();
44         }
45         parent::__construct($errorcode, 'quiz', $link, $a, $debuginfo);
46     }
47 }
50 /**
51  * A class encapsulating a quiz and the questions it contains, and making the
52  * information available to scripts like view.php.
53  *
54  * Initially, it only loads a minimal amout of information about each question - loading
55  * extra information only when necessary or when asked. The class tracks which questions
56  * are loaded.
57  *
58  * @copyright  2008 Tim Hunt
59  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
60  * @since      Moodle 2.0
61  */
62 class quiz {
63     /** @var stdClass the course settings from the database. */
64     protected $course;
65     /** @var stdClass the course_module settings from the database. */
66     protected $cm;
67     /** @var stdClass the quiz settings from the database. */
68     protected $quiz;
69     /** @var context the quiz context. */
70     protected $context;
72     /** @var array of questions augmented with slot information. */
73     protected $questions = null;
74     /** @var array of quiz_section rows. */
75     protected $sections = null;
76     /** @var quiz_access_manager the access manager for this quiz. */
77     protected $accessmanager = null;
78     /** @var bool whether the current user has capability mod/quiz:preview. */
79     protected $ispreviewuser = null;
81     // Constructor =============================================================
82     /**
83      * Constructor, assuming we already have the necessary data loaded.
84      *
85      * @param object $quiz the row from the quiz table.
86      * @param object $cm the course_module object for this quiz.
87      * @param object $course the row from the course table for the course we belong to.
88      * @param bool $getcontext intended for testing - stops the constructor getting the context.
89      */
90     public function __construct($quiz, $cm, $course, $getcontext = true) {
91         $this->quiz = $quiz;
92         $this->cm = $cm;
93         $this->quiz->cmid = $this->cm->id;
94         $this->course = $course;
95         if ($getcontext && !empty($cm->id)) {
96             $this->context = context_module::instance($cm->id);
97         }
98     }
100     /**
101      * Static function to create a new quiz object for a specific user.
102      *
103      * @param int $quizid the the quiz id.
104      * @param int $userid the the userid.
105      * @return quiz the new quiz object
106      */
107     public static function create($quizid, $userid = null) {
108         global $DB;
110         $quiz = quiz_access_manager::load_quiz_and_settings($quizid);
111         $course = $DB->get_record('course', array('id' => $quiz->course), '*', MUST_EXIST);
112         $cm = get_coursemodule_from_instance('quiz', $quiz->id, $course->id, false, MUST_EXIST);
114         // Update quiz with override information.
115         if ($userid) {
116             $quiz = quiz_update_effective_access($quiz, $userid);
117         }
119         return new quiz($quiz, $cm, $course);
120     }
122     /**
123      * Create a {@link quiz_attempt} for an attempt at this quiz.
124      * @param object $attemptdata row from the quiz_attempts table.
125      * @return quiz_attempt the new quiz_attempt object.
126      */
127     public function create_attempt_object($attemptdata) {
128         return new quiz_attempt($attemptdata, $this->quiz, $this->cm, $this->course);
129     }
131     // Functions for loading more data =========================================
133     /**
134      * Load just basic information about all the questions in this quiz.
135      */
136     public function preload_questions() {
137         $this->questions = question_preload_questions(null,
138                 'slot.maxmark, slot.id AS slotid, slot.slot, slot.page,
139                  slot.questioncategoryid AS randomfromcategory,
140                  slot.includingsubcategories AS randomincludingsubcategories',
141                 '{quiz_slots} slot ON slot.quizid = :quizid AND q.id = slot.questionid',
142                 array('quizid' => $this->quiz->id), 'slot.slot');
143     }
145     /**
146      * Fully load some or all of the questions for this quiz. You must call
147      * {@link preload_questions()} first.
148      *
149      * @param array $questionids question ids of the questions to load. null for all.
150      */
151     public function load_questions($questionids = null) {
152         if ($this->questions === null) {
153             throw new coding_exception('You must call preload_questions before calling load_questions.');
154         }
155         if (is_null($questionids)) {
156             $questionids = array_keys($this->questions);
157         }
158         $questionstoprocess = array();
159         foreach ($questionids as $id) {
160             if (array_key_exists($id, $this->questions)) {
161                 $questionstoprocess[$id] = $this->questions[$id];
162             }
163         }
164         get_question_options($questionstoprocess);
165     }
167     /**
168      * Get an instance of the {@link \mod_quiz\structure} class for this quiz.
169      * @return \mod_quiz\structure describes the questions in the quiz.
170      */
171     public function get_structure() {
172         return \mod_quiz\structure::create_for_quiz($this);
173     }
175     // Simple getters ==========================================================
176     /** @return int the course id. */
177     public function get_courseid() {
178         return $this->course->id;
179     }
181     /** @return object the row of the course table. */
182     public function get_course() {
183         return $this->course;
184     }
186     /** @return int the quiz id. */
187     public function get_quizid() {
188         return $this->quiz->id;
189     }
191     /** @return object the row of the quiz table. */
192     public function get_quiz() {
193         return $this->quiz;
194     }
196     /** @return string the name of this quiz. */
197     public function get_quiz_name() {
198         return $this->quiz->name;
199     }
201     /** @return int the quiz navigation method. */
202     public function get_navigation_method() {
203         return $this->quiz->navmethod;
204     }
206     /** @return int the number of attempts allowed at this quiz (0 = infinite). */
207     public function get_num_attempts_allowed() {
208         return $this->quiz->attempts;
209     }
211     /** @return int the course_module id. */
212     public function get_cmid() {
213         return $this->cm->id;
214     }
216     /** @return object the course_module object. */
217     public function get_cm() {
218         return $this->cm;
219     }
221     /** @return object the module context for this quiz. */
222     public function get_context() {
223         return $this->context;
224     }
226     /**
227      * @return bool wether the current user is someone who previews the quiz,
228      * rather than attempting it.
229      */
230     public function is_preview_user() {
231         if (is_null($this->ispreviewuser)) {
232             $this->ispreviewuser = has_capability('mod/quiz:preview', $this->context);
233         }
234         return $this->ispreviewuser;
235     }
237     /**
238      * Checks user enrollment in the current course.
239      *
240      * @param int $userid
241      * @return null|stdClass user record
242      */
243     public function is_participant($userid) {
244         return is_enrolled($this->get_context(), $userid, 'mod/quiz:attempt', $this->show_only_active_users());
245     }
247     /**
248      * Check is only active users in course should be shown.
249      *
250      * @return bool true if only active users should be shown.
251      */
252     public function show_only_active_users() {
253         return !has_capability('moodle/course:viewsuspendedusers', $this->get_context());
254     }
256     /**
257      * @return whether any questions have been added to this quiz.
258      */
259     public function has_questions() {
260         if ($this->questions === null) {
261             $this->preload_questions();
262         }
263         return !empty($this->questions);
264     }
266     /**
267      * @param int $id the question id.
268      * @return object the question object with that id.
269      */
270     public function get_question($id) {
271         return $this->questions[$id];
272     }
274     /**
275      * @param array $questionids question ids of the questions to load. null for all.
276      */
277     public function get_questions($questionids = null) {
278         if (is_null($questionids)) {
279             $questionids = array_keys($this->questions);
280         }
281         $questions = array();
282         foreach ($questionids as $id) {
283             if (!array_key_exists($id, $this->questions)) {
284                 throw new moodle_exception('cannotstartmissingquestion', 'quiz', $this->view_url());
285             }
286             $questions[$id] = $this->questions[$id];
287             $this->ensure_question_loaded($id);
288         }
289         return $questions;
290     }
292     /**
293      * Get all the sections in this quiz.
294      * @return array 0, 1, 2, ... => quiz_sections row from the database.
295      */
296     public function get_sections() {
297         global $DB;
298         if ($this->sections === null) {
299             $this->sections = array_values($DB->get_records('quiz_sections',
300                     array('quizid' => $this->get_quizid()), 'firstslot'));
301         }
302         return $this->sections;
303     }
305     /**
306      * Return quiz_access_manager and instance of the quiz_access_manager class
307      * for this quiz at this time.
308      * @param int $timenow the current time as a unix timestamp.
309      * @return quiz_access_manager and instance of the quiz_access_manager class
310      *      for this quiz at this time.
311      */
312     public function get_access_manager($timenow) {
313         if (is_null($this->accessmanager)) {
314             $this->accessmanager = new quiz_access_manager($this, $timenow,
315                     has_capability('mod/quiz:ignoretimelimits', $this->context, null, false));
316         }
317         return $this->accessmanager;
318     }
320     /**
321      * Wrapper round the has_capability funciton that automatically passes in the quiz context.
322      */
323     public function has_capability($capability, $userid = null, $doanything = true) {
324         return has_capability($capability, $this->context, $userid, $doanything);
325     }
327     /**
328      * Wrapper round the require_capability funciton that automatically passes in the quiz context.
329      */
330     public function require_capability($capability, $userid = null, $doanything = true) {
331         return require_capability($capability, $this->context, $userid, $doanything);
332     }
334     // URLs related to this attempt ============================================
335     /**
336      * @return string the URL of this quiz's view page.
337      */
338     public function view_url() {
339         global $CFG;
340         return $CFG->wwwroot . '/mod/quiz/view.php?id=' . $this->cm->id;
341     }
343     /**
344      * @return string the URL of this quiz's edit page.
345      */
346     public function edit_url() {
347         global $CFG;
348         return $CFG->wwwroot . '/mod/quiz/edit.php?cmid=' . $this->cm->id;
349     }
351     /**
352      * @param int $attemptid the id of an attempt.
353      * @param int $page optional page number to go to in the attempt.
354      * @return string the URL of that attempt.
355      */
356     public function attempt_url($attemptid, $page = 0) {
357         global $CFG;
358         $url = $CFG->wwwroot . '/mod/quiz/attempt.php?attempt=' . $attemptid;
359         if ($page) {
360             $url .= '&page=' . $page;
361         }
362         $url .= '&cmid=' . $this->get_cmid();
363         return $url;
364     }
366     /**
367      * @return string the URL of this quiz's edit page. Needs to be POSTed to with a cmid parameter.
368      */
369     public function start_attempt_url($page = 0) {
370         $params = array('cmid' => $this->cm->id, 'sesskey' => sesskey());
371         if ($page) {
372             $params['page'] = $page;
373         }
374         return new moodle_url('/mod/quiz/startattempt.php', $params);
375     }
377     /**
378      * @param int $attemptid the id of an attempt.
379      * @return string the URL of the review of that attempt.
380      */
381     public function review_url($attemptid) {
382         return new moodle_url('/mod/quiz/review.php', array('attempt' => $attemptid, 'cmid' => $this->get_cmid()));
383     }
385     /**
386      * @param int $attemptid the id of an attempt.
387      * @return string the URL of the review of that attempt.
388      */
389     public function summary_url($attemptid) {
390         return new moodle_url('/mod/quiz/summary.php', array('attempt' => $attemptid, 'cmid' => $this->get_cmid()));
391     }
393     // Bits of content =========================================================
395     /**
396      * @param bool $notused not used.
397      * @return string an empty string.
398      * @deprecated since 3.1. This sort of functionality is now entirely handled by quiz access rules.
399      */
400     public function confirm_start_attempt_message($notused) {
401         debugging('confirm_start_attempt_message is deprecated. ' .
402                 'This sort of functionality is now entirely handled by quiz access rules.');
403         return '';
404     }
406     /**
407      * If $reviewoptions->attempt is false, meaning that students can't review this
408      * attempt at the moment, return an appropriate string explaining why.
409      *
410      * @param int $when One of the mod_quiz_display_options::DURING,
411      *      IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
412      * @param bool $short if true, return a shorter string.
413      * @return string an appropraite message.
414      */
415     public function cannot_review_message($when, $short = false) {
417         if ($short) {
418             $langstrsuffix = 'short';
419             $dateformat = get_string('strftimedatetimeshort', 'langconfig');
420         } else {
421             $langstrsuffix = '';
422             $dateformat = '';
423         }
425         if ($when == mod_quiz_display_options::DURING ||
426                 $when == mod_quiz_display_options::IMMEDIATELY_AFTER) {
427             return '';
428         } else if ($when == mod_quiz_display_options::LATER_WHILE_OPEN && $this->quiz->timeclose &&
429                 $this->quiz->reviewattempt & mod_quiz_display_options::AFTER_CLOSE) {
430             return get_string('noreviewuntil' . $langstrsuffix, 'quiz',
431                     userdate($this->quiz->timeclose, $dateformat));
432         } else {
433             return get_string('noreview' . $langstrsuffix, 'quiz');
434         }
435     }
437     /**
438      * @param string $title the name of this particular quiz page.
439      * @return array the data that needs to be sent to print_header_simple as the $navigation
440      * parameter.
441      */
442     public function navigation($title) {
443         global $PAGE;
444         $PAGE->navbar->add($title);
445         return '';
446     }
448     // Private methods =========================================================
449     /**
450      * Check that the definition of a particular question is loaded, and if not throw an exception.
451      * @param $id a questionid.
452      */
453     protected function ensure_question_loaded($id) {
454         if (isset($this->questions[$id]->_partiallyloaded)) {
455             throw new moodle_quiz_exception($this, 'questionnotloaded', $id);
456         }
457     }
459     /**
460      * Return all the question types used in this quiz.
461      *
462      * @param  boolean $includepotential if the quiz include random questions, setting this flag to true will make the function to
463      * return all the possible question types in the random questions category
464      * @return array a sorted array including the different question types
465      * @since  Moodle 3.1
466      */
467     public function get_all_question_types_used($includepotential = false) {
468         $questiontypes = array();
470         // To control if we need to look in categories for questions.
471         $qcategories = array();
473         // We must be careful with random questions, if we find a random question we must assume that the quiz may content
474         // any of the questions in the referenced category (or subcategories).
475         foreach ($this->get_questions() as $questiondata) {
476             if ($questiondata->qtype == 'random' and $includepotential) {
477                 $includesubcategories = (bool) $questiondata->questiontext;
478                 if (!isset($qcategories[$questiondata->category])) {
479                     $qcategories[$questiondata->category] = false;
480                 }
481                 if ($includesubcategories) {
482                     $qcategories[$questiondata->category] = true;
483                 }
484             } else {
485                 if (!in_array($questiondata->qtype, $questiontypes)) {
486                     $questiontypes[] = $questiondata->qtype;
487                 }
488             }
489         }
491         if (!empty($qcategories)) {
492             // We have to look for all the question types in these categories.
493             $categoriestolook = array();
494             foreach ($qcategories as $cat => $includesubcats) {
495                 if ($includesubcats) {
496                     $categoriestolook = array_merge($categoriestolook, question_categorylist($cat));
497                 } else {
498                     $categoriestolook[] = $cat;
499                 }
500             }
501             $questiontypesincategories = question_bank::get_all_question_types_in_categories($categoriestolook);
502             $questiontypes = array_merge($questiontypes, $questiontypesincategories);
503         }
504         $questiontypes = array_unique($questiontypes);
505         sort($questiontypes);
507         return $questiontypes;
508     }
512 /**
513  * This class extends the quiz class to hold data about the state of a particular attempt,
514  * in addition to the data about the quiz.
515  *
516  * @copyright  2008 Tim Hunt
517  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
518  * @since      Moodle 2.0
519  */
520 class quiz_attempt {
522     /** @var string to identify the in progress state. */
523     const IN_PROGRESS = 'inprogress';
524     /** @var string to identify the overdue state. */
525     const OVERDUE     = 'overdue';
526     /** @var string to identify the finished state. */
527     const FINISHED    = 'finished';
528     /** @var string to identify the abandoned state. */
529     const ABANDONED   = 'abandoned';
531     /** @var int maximum number of slots in the quiz for the review page to default to show all. */
532     const MAX_SLOTS_FOR_DEFAULT_REVIEW_SHOW_ALL = 50;
534     /** @var quiz object containing the quiz settings. */
535     protected $quizobj;
537     /** @var stdClass the quiz_attempts row. */
538     protected $attempt;
540     /** @var question_usage_by_activity the question usage for this quiz attempt. */
541     protected $quba;
543     /**
544      * @var array of slot information. These objects contain ->slot (int),
545      *      ->requireprevious (bool), ->questionids (int) the original question for random questions,
546      *      ->firstinsection (bool), ->section (stdClass from $this->sections).
547      *      This does not contain page - get that from {@link get_question_page()} -
548      *      or maxmark - get that from $this->quba.
549      */
550     protected $slots;
552     /** @var array of quiz_sections rows, with a ->lastslot field added. */
553     protected $sections;
555     /** @var array page no => array of slot numbers on the page in order. */
556     protected $pagelayout;
558     /** @var array slot => displayed question number for this slot. (E.g. 1, 2, 3 or 'i'.) */
559     protected $questionnumbers;
561     /** @var array slot => page number for this slot. */
562     protected $questionpages;
564     /** @var mod_quiz_display_options cache for the appropriate review options. */
565     protected $reviewoptions = null;
567     // Constructor =============================================================
568     /**
569      * Constructor assuming we already have the necessary data loaded.
570      *
571      * @param object $attempt the row of the quiz_attempts table.
572      * @param object $quiz the quiz object for this attempt and user.
573      * @param object $cm the course_module object for this quiz.
574      * @param object $course the row from the course table for the course we belong to.
575      * @param bool $loadquestions (optional) if true, the default, load all the details
576      *      of the state of each question. Else just set up the basic details of the attempt.
577      */
578     public function __construct($attempt, $quiz, $cm, $course, $loadquestions = true) {
579         global $DB;
581         $this->attempt = $attempt;
582         $this->quizobj = new quiz($quiz, $cm, $course);
584         if (!$loadquestions) {
585             return;
586         }
588         $this->quba = question_engine::load_questions_usage_by_activity($this->attempt->uniqueid);
589         $this->slots = $DB->get_records('quiz_slots',
590                 array('quizid' => $this->get_quizid()), 'slot',
591                 'slot, id, requireprevious, questionid, includingsubcategories');
592         $this->sections = array_values($DB->get_records('quiz_sections',
593                 array('quizid' => $this->get_quizid()), 'firstslot'));
595         $this->link_sections_and_slots();
596         $this->determine_layout();
597         $this->number_questions();
598     }
600     /**
601      * Used by {create()} and {create_from_usage_id()}.
602      * @param array $conditions passed to $DB->get_record('quiz_attempts', $conditions).
603      */
604     protected static function create_helper($conditions) {
605         global $DB;
607         $attempt = $DB->get_record('quiz_attempts', $conditions, '*', MUST_EXIST);
608         $quiz = quiz_access_manager::load_quiz_and_settings($attempt->quiz);
609         $course = $DB->get_record('course', array('id' => $quiz->course), '*', MUST_EXIST);
610         $cm = get_coursemodule_from_instance('quiz', $quiz->id, $course->id, false, MUST_EXIST);
612         // Update quiz with override information.
613         $quiz = quiz_update_effective_access($quiz, $attempt->userid);
615         return new quiz_attempt($attempt, $quiz, $cm, $course);
616     }
618     /**
619      * Static function to create a new quiz_attempt object given an attemptid.
620      *
621      * @param int $attemptid the attempt id.
622      * @return quiz_attempt the new quiz_attempt object
623      */
624     public static function create($attemptid) {
625         return self::create_helper(array('id' => $attemptid));
626     }
628     /**
629      * Static function to create a new quiz_attempt object given a usage id.
630      *
631      * @param int $usageid the attempt usage id.
632      * @return quiz_attempt the new quiz_attempt object
633      */
634     public static function create_from_usage_id($usageid) {
635         return self::create_helper(array('uniqueid' => $usageid));
636     }
638     /**
639      * @param string $state one of the state constants like IN_PROGRESS.
640      * @return string the human-readable state name.
641      */
642     public static function state_name($state) {
643         return quiz_attempt_state_name($state);
644     }
646     /**
647      * Let each slot know which section it is part of.
648      */
649     protected function link_sections_and_slots() {
650         foreach ($this->sections as $i => $section) {
651             if (isset($this->sections[$i + 1])) {
652                 $section->lastslot = $this->sections[$i + 1]->firstslot - 1;
653             } else {
654                 $section->lastslot = count($this->slots);
655             }
656             for ($slot = $section->firstslot; $slot <= $section->lastslot; $slot += 1) {
657                 $this->slots[$slot]->section = $section;
658             }
659         }
660     }
662     /**
663      * Parse attempt->layout to populate the other arrays the represent the layout.
664      */
665     protected function determine_layout() {
666         $this->pagelayout = array();
668         // Break up the layout string into pages.
669         $pagelayouts = explode(',0', $this->attempt->layout);
671         // Strip off any empty last page (normally there is one).
672         if (end($pagelayouts) == '') {
673             array_pop($pagelayouts);
674         }
676         // File the ids into the arrays.
677         // Tracking which is the first slot in each section in this attempt is
678         // trickier than you might guess, since the slots in this section
679         // may be shuffled, so $section->firstslot (the lowest numbered slot in
680         // the section) may not be the first one.
681         $unseensections = $this->sections;
682         $this->pagelayout = array();
683         foreach ($pagelayouts as $page => $pagelayout) {
684             $pagelayout = trim($pagelayout, ',');
685             if ($pagelayout == '') {
686                 continue;
687             }
688             $this->pagelayout[$page] = explode(',', $pagelayout);
689             foreach ($this->pagelayout[$page] as $slot) {
690                 $sectionkey = array_search($this->slots[$slot]->section, $unseensections);
691                 if ($sectionkey !== false) {
692                     $this->slots[$slot]->firstinsection = true;
693                     unset($unseensections[$sectionkey]);
694                 } else {
695                     $this->slots[$slot]->firstinsection = false;
696                 }
697             }
698         }
699     }
701     /**
702      * Work out the number to display for each question/slot.
703      */
704     protected function number_questions() {
705         $number = 1;
706         foreach ($this->pagelayout as $page => $slots) {
707             foreach ($slots as $slot) {
708                 if ($length = $this->is_real_question($slot)) {
709                     $this->questionnumbers[$slot] = $number;
710                     $number += $length;
711                 } else {
712                     $this->questionnumbers[$slot] = get_string('infoshort', 'quiz');
713                 }
714                 $this->questionpages[$slot] = $page;
715             }
716         }
717     }
719     /**
720      * If the given page number is out of range (before the first page, or after
721      * the last page, chnage it to be within range).
722      * @param int $page the requested page number.
723      * @return int a safe page number to use.
724      */
725     public function force_page_number_into_range($page) {
726         return min(max($page, 0), count($this->pagelayout) - 1);
727     }
729     // Simple getters ==========================================================
730     public function get_quiz() {
731         return $this->quizobj->get_quiz();
732     }
734     public function get_quizobj() {
735         return $this->quizobj;
736     }
738     /** @return int the course id. */
739     public function get_courseid() {
740         return $this->quizobj->get_courseid();
741     }
743     /** @return int the course id. */
744     public function get_course() {
745         return $this->quizobj->get_course();
746     }
748     /** @return int the quiz id. */
749     public function get_quizid() {
750         return $this->quizobj->get_quizid();
751     }
753     /** @return string the name of this quiz. */
754     public function get_quiz_name() {
755         return $this->quizobj->get_quiz_name();
756     }
758     /** @return int the quiz navigation method. */
759     public function get_navigation_method() {
760         return $this->quizobj->get_navigation_method();
761     }
763     /** @return object the course_module object. */
764     public function get_cm() {
765         return $this->quizobj->get_cm();
766     }
768     /** @return object the course_module object. */
769     public function get_cmid() {
770         return $this->quizobj->get_cmid();
771     }
773     /**
774      * @return bool wether the current user is someone who previews the quiz,
775      * rather than attempting it.
776      */
777     public function is_preview_user() {
778         return $this->quizobj->is_preview_user();
779     }
781     /** @return int the number of attempts allowed at this quiz (0 = infinite). */
782     public function get_num_attempts_allowed() {
783         return $this->quizobj->get_num_attempts_allowed();
784     }
786     /** @return int number fo pages in this quiz. */
787     public function get_num_pages() {
788         return count($this->pagelayout);
789     }
791     /**
792      * @param int $timenow the current time as a unix timestamp.
793      * @return quiz_access_manager and instance of the quiz_access_manager class
794      *      for this quiz at this time.
795      */
796     public function get_access_manager($timenow) {
797         return $this->quizobj->get_access_manager($timenow);
798     }
800     /** @return int the attempt id. */
801     public function get_attemptid() {
802         return $this->attempt->id;
803     }
805     /** @return int the attempt unique id. */
806     public function get_uniqueid() {
807         return $this->attempt->uniqueid;
808     }
810     /** @return object the row from the quiz_attempts table. */
811     public function get_attempt() {
812         return $this->attempt;
813     }
815     /** @return int the number of this attemp (is it this user's first, second, ... attempt). */
816     public function get_attempt_number() {
817         return $this->attempt->attempt;
818     }
820     /** @return string one of the quiz_attempt::IN_PROGRESS, FINISHED, OVERDUE or ABANDONED constants. */
821     public function get_state() {
822         return $this->attempt->state;
823     }
825     /** @return int the id of the user this attempt belongs to. */
826     public function get_userid() {
827         return $this->attempt->userid;
828     }
830     /** @return int the current page of the attempt. */
831     public function get_currentpage() {
832         return $this->attempt->currentpage;
833     }
835     public function get_sum_marks() {
836         return $this->attempt->sumgrades;
837     }
839     /**
840      * @return bool whether this attempt has been finished (true) or is still
841      *     in progress (false). Be warned that this is not just state == self::FINISHED,
842      *     it also includes self::ABANDONED.
843      */
844     public function is_finished() {
845         return $this->attempt->state == self::FINISHED || $this->attempt->state == self::ABANDONED;
846     }
848     /** @return bool whether this attempt is a preview attempt. */
849     public function is_preview() {
850         return $this->attempt->preview;
851     }
853     /**
854      * Is this someone dealing with their own attempt or preview?
855      *
856      * @return bool true => own attempt/preview. false => reviewing someone elses.
857      */
858     public function is_own_attempt() {
859         global $USER;
860         return $this->attempt->userid == $USER->id;
861     }
863     /**
864      * @return bool whether this attempt is a preview belonging to the current user.
865      */
866     public function is_own_preview() {
867         global $USER;
868         return $this->is_own_attempt() &&
869                 $this->is_preview_user() && $this->attempt->preview;
870     }
872     /**
873      * Is the current user allowed to review this attempt. This applies when
874      * {@link is_own_attempt()} returns false.
875      * @return bool whether the review should be allowed.
876      */
877     public function is_review_allowed() {
878         if (!$this->has_capability('mod/quiz:viewreports')) {
879             return false;
880         }
882         $cm = $this->get_cm();
883         if ($this->has_capability('moodle/site:accessallgroups') ||
884                 groups_get_activity_groupmode($cm) != SEPARATEGROUPS) {
885             return true;
886         }
888         // Check the users have at least one group in common.
889         $teachersgroups = groups_get_activity_allowed_groups($cm);
890         $studentsgroups = groups_get_all_groups(
891                 $cm->course, $this->attempt->userid, $cm->groupingid);
892         return $teachersgroups && $studentsgroups &&
893                 array_intersect(array_keys($teachersgroups), array_keys($studentsgroups));
894     }
896     /**
897      * Has the student, in this attempt, engaged with the quiz in a non-trivial way?
898      * That is, is there any question worth a non-zero number of marks, where
899      * the student has made some response that we have saved?
900      * @return bool true if we have saved a response for at least one graded question.
901      */
902     public function has_response_to_at_least_one_graded_question() {
903         foreach ($this->quba->get_attempt_iterator() as $qa) {
904             if ($qa->get_max_mark() == 0) {
905                 continue;
906             }
907             if ($qa->get_num_steps() > 1) {
908                 return true;
909             }
910         }
911         return false;
912     }
914     /**
915      * Get extra summary information about this attempt.
916      *
917      * Some behaviours may be able to provide interesting summary information
918      * about the attempt as a whole, and this method provides access to that data.
919      * To see how this works, try setting a quiz to one of the CBM behaviours,
920      * and then look at the extra information displayed at the top of the quiz
921      * review page once you have sumitted an attempt.
922      *
923      * In the return value, the array keys are identifiers of the form
924      * qbehaviour_behaviourname_meaningfullkey. For qbehaviour_deferredcbm_highsummary.
925      * The values are arrays with two items, title and content. Each of these
926      * will be either a string, or a renderable.
927      *
928      * @param question_display_options $options the display options for this quiz attempt at this time.
929      * @return array as described above.
930      */
931     public function get_additional_summary_data(question_display_options $options) {
932         return $this->quba->get_summary_information($options);
933     }
935     /**
936      * Get the overall feedback corresponding to a particular mark.
937      * @param $grade a particular grade.
938      */
939     public function get_overall_feedback($grade) {
940         return quiz_feedback_for_grade($grade, $this->get_quiz(),
941                 $this->quizobj->get_context());
942     }
944     /**
945      * Wrapper round the has_capability funciton that automatically passes in the quiz context.
946      */
947     public function has_capability($capability, $userid = null, $doanything = true) {
948         return $this->quizobj->has_capability($capability, $userid, $doanything);
949     }
951     /**
952      * Wrapper round the require_capability funciton that automatically passes in the quiz context.
953      */
954     public function require_capability($capability, $userid = null, $doanything = true) {
955         return $this->quizobj->require_capability($capability, $userid, $doanything);
956     }
958     /**
959      * Check the appropriate capability to see whether this user may review their own attempt.
960      * If not, prints an error.
961      */
962     public function check_review_capability() {
963         if ($this->get_attempt_state() == mod_quiz_display_options::IMMEDIATELY_AFTER) {
964             $capability = 'mod/quiz:attempt';
965         } else {
966             $capability = 'mod/quiz:reviewmyattempts';
967         }
969         // These next tests are in a slighly funny order. The point is that the
970         // common and most performance-critical case is students attempting a quiz
971         // so we want to check that permisison first.
973         if ($this->has_capability($capability)) {
974             // User has the permission that lets you do the quiz as a student. Fine.
975             return;
976         }
978         if ($this->has_capability('mod/quiz:viewreports') ||
979                 $this->has_capability('mod/quiz:preview')) {
980             // User has the permission that lets teachers review. Fine.
981             return;
982         }
984         // They should not be here. Trigger the standard no-permission error
985         // but using the name of the student capability.
986         // We know this will fail. We just want the stadard exception thown.
987         $this->require_capability($capability);
988     }
990     /**
991      * Checks whether a user may navigate to a particular slot
992      */
993     public function can_navigate_to($slot) {
994         switch ($this->get_navigation_method()) {
995             case QUIZ_NAVMETHOD_FREE:
996                 return true;
997                 break;
998             case QUIZ_NAVMETHOD_SEQ:
999                 return false;
1000                 break;
1001         }
1002         return true;
1003     }
1005     /**
1006      * @return int one of the mod_quiz_display_options::DURING,
1007      *      IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
1008      */
1009     public function get_attempt_state() {
1010         return quiz_attempt_state($this->get_quiz(), $this->attempt);
1011     }
1013     /**
1014      * Wrapper that the correct mod_quiz_display_options for this quiz at the
1015      * moment.
1016      *
1017      * @return question_display_options the render options for this user on this attempt.
1018      */
1019     public function get_display_options($reviewing) {
1020         if ($reviewing) {
1021             if (is_null($this->reviewoptions)) {
1022                 $this->reviewoptions = quiz_get_review_options($this->get_quiz(),
1023                         $this->attempt, $this->quizobj->get_context());
1024                 if ($this->is_own_preview()) {
1025                     // It should  always be possible for a teacher to review their
1026                     // own preview irrespective of the review options settings.
1027                     $this->reviewoptions->attempt = true;
1028                 }
1029             }
1030             return $this->reviewoptions;
1032         } else {
1033             $options = mod_quiz_display_options::make_from_quiz($this->get_quiz(),
1034                     mod_quiz_display_options::DURING);
1035             $options->flags = quiz_get_flag_option($this->attempt, $this->quizobj->get_context());
1036             return $options;
1037         }
1038     }
1040     /**
1041      * Wrapper that the correct mod_quiz_display_options for this quiz at the
1042      * moment.
1043      *
1044      * @param bool $reviewing true for review page, else attempt page.
1045      * @param int $slot which question is being displayed.
1046      * @param moodle_url $thispageurl to return to after the editing form is
1047      *      submitted or cancelled. If null, no edit link will be generated.
1048      *
1049      * @return question_display_options the render options for this user on this
1050      *      attempt, with extra info to generate an edit link, if applicable.
1051      */
1052     public function get_display_options_with_edit_link($reviewing, $slot, $thispageurl) {
1053         $options = clone($this->get_display_options($reviewing));
1055         if (!$thispageurl) {
1056             return $options;
1057         }
1059         if (!($reviewing || $this->is_preview())) {
1060             return $options;
1061         }
1063         $question = $this->quba->get_question($slot);
1064         if (!question_has_capability_on($question, 'edit', $question->category)) {
1065             return $options;
1066         }
1068         $options->editquestionparams['cmid'] = $this->get_cmid();
1069         $options->editquestionparams['returnurl'] = $thispageurl;
1071         return $options;
1072     }
1074     /**
1075      * @param int $page page number
1076      * @return bool true if this is the last page of the quiz.
1077      */
1078     public function is_last_page($page) {
1079         return $page == count($this->pagelayout) - 1;
1080     }
1082     /**
1083      * Return the list of slot numbers for either a given page of the quiz, or for the
1084      * whole quiz.
1085      *
1086      * @param mixed $page string 'all' or integer page number.
1087      * @return array the requested list of slot numbers.
1088      */
1089     public function get_slots($page = 'all') {
1090         if ($page === 'all') {
1091             $numbers = array();
1092             foreach ($this->pagelayout as $numbersonpage) {
1093                 $numbers = array_merge($numbers, $numbersonpage);
1094             }
1095             return $numbers;
1096         } else {
1097             return $this->pagelayout[$page];
1098         }
1099     }
1101     /**
1102      * Return the list of slot numbers for either a given page of the quiz, or for the
1103      * whole quiz.
1104      *
1105      * @param mixed $page string 'all' or integer page number.
1106      * @return array the requested list of slot numbers.
1107      */
1108     public function get_active_slots($page = 'all') {
1109         $activeslots = array();
1110         foreach ($this->get_slots($page) as $slot) {
1111             if (!$this->is_blocked_by_previous_question($slot)) {
1112                 $activeslots[] = $slot;
1113             }
1114         }
1115         return $activeslots;
1116     }
1118     /**
1119      * Helper method for unit tests. Get the underlying question usage object.
1120      * @return question_usage_by_activity the usage.
1121      */
1122     public function get_question_usage() {
1123         if (!(PHPUNIT_TEST || defined('BEHAT_TEST'))) {
1124             throw new coding_exception('get_question_usage is only for use in unit tests. ' .
1125                     'For other operations, use the quiz_attempt api, or extend it properly.');
1126         }
1127         return $this->quba;
1128     }
1130     /**
1131      * Get the question_attempt object for a particular question in this attempt.
1132      * @param int $slot the number used to identify this question within this attempt.
1133      * @return question_attempt
1134      */
1135     public function get_question_attempt($slot) {
1136         return $this->quba->get_question_attempt($slot);
1137     }
1139     /**
1140      * Get the question_attempt object for a particular question in this attempt.
1141      * @param int $slot the number used to identify this question within this attempt.
1142      * @return question_attempt
1143      */
1144     public function all_question_attempts_originally_in_slot($slot) {
1145         $qas = array();
1146         foreach ($this->quba->get_attempt_iterator() as $qa) {
1147             if ($qa->get_metadata('originalslot') == $slot) {
1148                 $qas[] = $qa;
1149             }
1150         }
1151         $qas[] = $this->quba->get_question_attempt($slot);
1152         return $qas;
1153     }
1155     /**
1156      * Is a particular question in this attempt a real question, or something like a description.
1157      * @param int $slot the number used to identify this question within this attempt.
1158      * @return int whether that question is a real question. Actually returns the
1159      *     question length, which could theoretically be greater than one.
1160      */
1161     public function is_real_question($slot) {
1162         return $this->quba->get_question($slot)->length;
1163     }
1165     /**
1166      * Is a particular question in this attempt a real question, or something like a description.
1167      * @param int $slot the number used to identify this question within this attempt.
1168      * @return bool whether that question is a real question.
1169      */
1170     public function is_question_flagged($slot) {
1171         return $this->quba->get_question_attempt($slot)->is_flagged();
1172     }
1174     /**
1175      * Checks whether the question in this slot requires the previous question to have been completed.
1176      *
1177      * @param int $slot the number used to identify this question within this attempt.
1178      * @return bool whether the previous question must have been completed before this one can be seen.
1179      */
1180     public function is_blocked_by_previous_question($slot) {
1181         return $slot > 1 && isset($this->slots[$slot]) && $this->slots[$slot]->requireprevious &&
1182                 !$this->slots[$slot]->section->shufflequestions &&
1183                 !$this->slots[$slot - 1]->section->shufflequestions &&
1184                 $this->get_navigation_method() != QUIZ_NAVMETHOD_SEQ &&
1185                 !$this->get_question_state($slot - 1)->is_finished() &&
1186                 $this->quba->can_question_finish_during_attempt($slot - 1);
1187     }
1189     /**
1190      * Is it possible for this question to be re-started within this attempt?
1191      *
1192      * @param int $slot the number used to identify this question within this attempt.
1193      * @return whether the student should be given the option to restart this question now.
1194      */
1195     public function can_question_be_redone_now($slot) {
1196         return $this->get_quiz()->canredoquestions && !$this->is_finished() &&
1197                 $this->get_question_state($slot)->is_finished();
1198     }
1200     /**
1201      * Given a slot in this attempt, which may or not be a redone question, return the original slot.
1202      *
1203      * @param int $slot identifies a particular question in this attempt.
1204      * @return int the slot where this question was originally.
1205      */
1206     public function get_original_slot($slot) {
1207         $originalslot = $this->quba->get_question_attempt_metadata($slot, 'originalslot');
1208         if ($originalslot) {
1209             return $originalslot;
1210         } else {
1211             return $slot;
1212         }
1213     }
1215     /**
1216      * Get the displayed question number for a slot.
1217      * @param int $slot the number used to identify this question within this attempt.
1218      * @return string the displayed question number for the question in this slot.
1219      *      For example '1', '2', '3' or 'i'.
1220      */
1221     public function get_question_number($slot) {
1222         return $this->questionnumbers[$slot];
1223     }
1225     /**
1226      * If the section heading, if any, that should come just before this slot.
1227      * @param int $slot identifies a particular question in this attempt.
1228      * @return string the required heading, or null if there is not one here.
1229      */
1230     public function get_heading_before_slot($slot) {
1231         if ($this->slots[$slot]->firstinsection) {
1232             return $this->slots[$slot]->section->heading;
1233         } else {
1234             return null;
1235         }
1236     }
1238     /**
1239      * Return the page of the quiz where this question appears.
1240      * @param int $slot the number used to identify this question within this attempt.
1241      * @return int the page of the quiz this question appears on.
1242      */
1243     public function get_question_page($slot) {
1244         return $this->questionpages[$slot];
1245     }
1247     /**
1248      * Return the grade obtained on a particular question, if the user is permitted
1249      * to see it. You must previously have called load_question_states to load the
1250      * state data about this question.
1251      *
1252      * @param int $slot the number used to identify this question within this attempt.
1253      * @return string the formatted grade, to the number of decimal places specified
1254      *      by the quiz.
1255      */
1256     public function get_question_name($slot) {
1257         return $this->quba->get_question($slot)->name;
1258     }
1260     /**
1261      * Return the {@link question_state} that this question is in.
1262      *
1263      * @param int $slot the number used to identify this question within this attempt.
1264      * @return question_state the state this question is in.
1265      */
1266     public function get_question_state($slot) {
1267         return $this->quba->get_question_state($slot);
1268     }
1270     /**
1271      * Return the grade obtained on a particular question, if the user is permitted
1272      * to see it. You must previously have called load_question_states to load the
1273      * state data about this question.
1274      *
1275      * @param int $slot the number used to identify this question within this attempt.
1276      * @param bool $showcorrectness Whether right/partial/wrong states should
1277      * be distinguised.
1278      * @return string the formatted grade, to the number of decimal places specified
1279      *      by the quiz.
1280      */
1281     public function get_question_status($slot, $showcorrectness) {
1282         return $this->quba->get_question_state_string($slot, $showcorrectness);
1283     }
1285     /**
1286      * Return the grade obtained on a particular question, if the user is permitted
1287      * to see it. You must previously have called load_question_states to load the
1288      * state data about this question.
1289      *
1290      * @param int $slot the number used to identify this question within this attempt.
1291      * @param bool $showcorrectness Whether right/partial/wrong states should
1292      * be distinguised.
1293      * @return string class name for this state.
1294      */
1295     public function get_question_state_class($slot, $showcorrectness) {
1296         return $this->quba->get_question_state_class($slot, $showcorrectness);
1297     }
1299     /**
1300      * Return the grade obtained on a particular question.
1301      * You must previously have called load_question_states to load the state
1302      * data about this question.
1303      *
1304      * @param int $slot the number used to identify this question within this attempt.
1305      * @return string the formatted grade, to the number of decimal places specified by the quiz.
1306      */
1307     public function get_question_mark($slot) {
1308         return quiz_format_question_grade($this->get_quiz(), $this->quba->get_question_mark($slot));
1309     }
1311     /**
1312      * Get the time of the most recent action performed on a question.
1313      * @param int $slot the number used to identify this question within this usage.
1314      * @return int timestamp.
1315      */
1316     public function get_question_action_time($slot) {
1317         return $this->quba->get_question_action_time($slot);
1318     }
1320     /**
1321      * Return the question type name for a given slot within the current attempt.
1322      *
1323      * @param int $slot the number used to identify this question within this attempt.
1324      * @return string the question type name
1325      * @since  Moodle 3.1
1326      */
1327     public function get_question_type_name($slot) {
1328         return $this->quba->get_question($slot)->get_type_name();
1329     }
1331     /**
1332      * Get the time remaining for an in-progress attempt, if the time is short
1333      * enought that it would be worth showing a timer.
1334      * @param int $timenow the time to consider as 'now'.
1335      * @return int|false the number of seconds remaining for this attempt.
1336      *      False if there is no limit.
1337      */
1338     public function get_time_left_display($timenow) {
1339         if ($this->attempt->state != self::IN_PROGRESS) {
1340             return false;
1341         }
1342         return $this->get_access_manager($timenow)->get_time_left_display($this->attempt, $timenow);
1343     }
1346     /**
1347      * @return int the time when this attempt was submitted. 0 if it has not been
1348      * submitted yet.
1349      */
1350     public function get_submitted_date() {
1351         return $this->attempt->timefinish;
1352     }
1354     /**
1355      * If the attempt is in an applicable state, work out the time by which the
1356      * student should next do something.
1357      * @return int timestamp by which the student needs to do something.
1358      */
1359     public function get_due_date() {
1360         $deadlines = array();
1361         if ($this->quizobj->get_quiz()->timelimit) {
1362             $deadlines[] = $this->attempt->timestart + $this->quizobj->get_quiz()->timelimit;
1363         }
1364         if ($this->quizobj->get_quiz()->timeclose) {
1365             $deadlines[] = $this->quizobj->get_quiz()->timeclose;
1366         }
1367         if ($deadlines) {
1368             $duedate = min($deadlines);
1369         } else {
1370             return false;
1371         }
1373         switch ($this->attempt->state) {
1374             case self::IN_PROGRESS:
1375                 return $duedate;
1377             case self::OVERDUE:
1378                 return $duedate + $this->quizobj->get_quiz()->graceperiod;
1380             default:
1381                 throw new coding_exception('Unexpected state: ' . $this->attempt->state);
1382         }
1383     }
1385     // URLs related to this attempt ============================================
1386     /**
1387      * @return string quiz view url.
1388      */
1389     public function view_url() {
1390         return $this->quizobj->view_url();
1391     }
1393     /**
1394      * @return string the URL of this quiz's edit page. Needs to be POSTed to with a cmid parameter.
1395      */
1396     public function start_attempt_url($slot = null, $page = -1) {
1397         if ($page == -1 && !is_null($slot)) {
1398             $page = $this->get_question_page($slot);
1399         } else {
1400             $page = 0;
1401         }
1402         return $this->quizobj->start_attempt_url($page);
1403     }
1405     /**
1406      * Generates the title of the attempt page.
1407      *
1408      * @param int $page the page number (starting with 0) in the attempt.
1409      * @return string
1410      */
1411     public function attempt_page_title(int $page) : string {
1412         if ($this->get_num_pages() > 1) {
1413             $a = new stdClass();
1414             $a->name = $this->get_quiz_name();
1415             $a->currentpage = $page + 1;
1416             $a->totalpages = $this->get_num_pages();
1417             $title = get_string('attempttitlepaged', 'quiz', $a);
1418         } else {
1419             $title = get_string('attempttitle', 'quiz', $this->get_quiz_name());
1420         }
1422         return $title;
1423     }
1425     /**
1426      * @param int $slot if speified, the slot number of a specific question to link to.
1427      * @param int $page if specified, a particular page to link to. If not givem deduced
1428      *      from $slot, or goes to the first page.
1429      * @param int $thispage if not -1, the current page. Will cause links to other things on
1430      * this page to be output as only a fragment.
1431      * @return string the URL to continue this attempt.
1432      */
1433     public function attempt_url($slot = null, $page = -1, $thispage = -1) {
1434         return $this->page_and_question_url('attempt', $slot, $page, false, $thispage);
1435     }
1437     /**
1438      * Generates the title of the summary page.
1439      *
1440      * @return string
1441      */
1442     public function summary_page_title() : string {
1443         return get_string('attemptsummarytitle', 'quiz', $this->get_quiz_name());
1444     }
1446     /**
1447      * @return string the URL of this quiz's summary page.
1448      */
1449     public function summary_url() {
1450         return new moodle_url('/mod/quiz/summary.php', array('attempt' => $this->attempt->id, 'cmid' => $this->get_cmid()));
1451     }
1453     /**
1454      * @return string the URL of this quiz's summary page.
1455      */
1456     public function processattempt_url() {
1457         return new moodle_url('/mod/quiz/processattempt.php');
1458     }
1460     /**
1461      * Generates the title of the review page.
1462      *
1463      * @param int $page the page number (starting with 0) in the attempt.
1464      * @param bool $showall whether the review page contains the entire attempt on one page.
1465      * @return string
1466      */
1467     public function review_page_title(int $page, bool $showall = false) : string {
1468         if (!$showall && $this->get_num_pages() > 1) {
1469             $a = new stdClass();
1470             $a->name = $this->get_quiz_name();
1471             $a->currentpage = $page + 1;
1472             $a->totalpages = $this->get_num_pages();
1473             $title = get_string('attemptreviewtitlepaged', 'quiz', $a);
1474         } else {
1475             $title = get_string('attemptreviewtitle', 'quiz', $this->get_quiz_name());
1476         }
1478         return $title;
1479     }
1481     /**
1482      * @param int $slot indicates which question to link to.
1483      * @param int $page if specified, the URL of this particular page of the attempt, otherwise
1484      * the URL will go to the first page.  If -1, deduce $page from $slot.
1485      * @param bool|null $showall if true, the URL will be to review the entire attempt on one page,
1486      * and $page will be ignored. If null, a sensible default will be chosen.
1487      * @param int $thispage if not -1, the current page. Will cause links to other things on
1488      * this page to be output as only a fragment.
1489      * @return string the URL to review this attempt.
1490      */
1491     public function review_url($slot = null, $page = -1, $showall = null, $thispage = -1) {
1492         return $this->page_and_question_url('review', $slot, $page, $showall, $thispage);
1493     }
1495     /**
1496      * By default, should this script show all questions on one page for this attempt?
1497      * @param string $script the script name, e.g. 'attempt', 'summary', 'review'.
1498      * @return whether show all on one page should be on by default.
1499      */
1500     public function get_default_show_all($script) {
1501         return $script == 'review' && count($this->questionpages) < self::MAX_SLOTS_FOR_DEFAULT_REVIEW_SHOW_ALL;
1502     }
1504     // Bits of content =========================================================
1506     /**
1507      * If $reviewoptions->attempt is false, meaning that students can't review this
1508      * attempt at the moment, return an appropriate string explaining why.
1509      *
1510      * @param bool $short if true, return a shorter string.
1511      * @return string an appropraite message.
1512      */
1513     public function cannot_review_message($short = false) {
1514         return $this->quizobj->cannot_review_message(
1515                 $this->get_attempt_state(), $short);
1516     }
1518     /**
1519      * Initialise the JS etc. required all the questions on a page.
1520      * @param mixed $page a page number, or 'all'.
1521      */
1522     public function get_html_head_contributions($page = 'all', $showall = false) {
1523         if ($showall) {
1524             $page = 'all';
1525         }
1526         $result = '';
1527         foreach ($this->get_slots($page) as $slot) {
1528             $result .= $this->quba->render_question_head_html($slot);
1529         }
1530         $result .= question_engine::initialise_js();
1531         return $result;
1532     }
1534     /**
1535      * Initialise the JS etc. required by one question.
1536      * @param int $questionid the question id.
1537      */
1538     public function get_question_html_head_contributions($slot) {
1539         return $this->quba->render_question_head_html($slot) .
1540                 question_engine::initialise_js();
1541     }
1543     /**
1544      * Print the HTML for the start new preview button, if the current user
1545      * is allowed to see one.
1546      */
1547     public function restart_preview_button() {
1548         global $OUTPUT;
1549         if ($this->is_preview() && $this->is_preview_user()) {
1550             return $OUTPUT->single_button(new moodle_url(
1551                     $this->start_attempt_url(), array('forcenew' => true)),
1552                     get_string('startnewpreview', 'quiz'));
1553         } else {
1554             return '';
1555         }
1556     }
1558     /**
1559      * Generate the HTML that displayes the question in its current state, with
1560      * the appropriate display options.
1561      *
1562      * @param int $slot identifies the question in the attempt.
1563      * @param bool $reviewing is the being printed on an attempt or a review page.
1564      * @param mod_quiz_renderer $renderer the quiz renderer.
1565      * @param moodle_url $thispageurl the URL of the page this question is being printed on.
1566      * @return string HTML for the question in its current state.
1567      */
1568     public function render_question($slot, $reviewing, mod_quiz_renderer $renderer, $thispageurl = null) {
1569         if ($this->is_blocked_by_previous_question($slot)) {
1570             $placeholderqa = $this->make_blocked_question_placeholder($slot);
1572             $displayoptions = $this->get_display_options($reviewing);
1573             $displayoptions->manualcomment = question_display_options::HIDDEN;
1574             $displayoptions->history = question_display_options::HIDDEN;
1575             $displayoptions->readonly = true;
1577             return html_writer::div($placeholderqa->render($displayoptions,
1578                     $this->get_question_number($this->get_original_slot($slot))),
1579                     'mod_quiz-blocked_question_warning');
1580         }
1582         return $this->render_question_helper($slot, $reviewing, $thispageurl, $renderer, null);
1583     }
1585     /**
1586      * Helper used by {@link render_question()} and {@link render_question_at_step()}.
1587      *
1588      * @param int $slot identifies the question in the attempt.
1589      * @param bool $reviewing is the being printed on an attempt or a review page.
1590      * @param moodle_url $thispageurl the URL of the page this question is being printed on.
1591      * @param mod_quiz_renderer $renderer the quiz renderer.
1592      * @param int|null $seq the seq number of the past state to display.
1593      * @return string HTML fragment.
1594      */
1595     protected function render_question_helper($slot, $reviewing, $thispageurl, mod_quiz_renderer $renderer, $seq) {
1596         $originalslot = $this->get_original_slot($slot);
1597         $number = $this->get_question_number($originalslot);
1598         $displayoptions = $this->get_display_options_with_edit_link($reviewing, $slot, $thispageurl);
1600         if ($slot != $originalslot) {
1601             $originalmaxmark = $this->get_question_attempt($slot)->get_max_mark();
1602             $this->get_question_attempt($slot)->set_max_mark($this->get_question_attempt($originalslot)->get_max_mark());
1603         }
1605         if ($this->can_question_be_redone_now($slot)) {
1606             $displayoptions->extrainfocontent = $renderer->redo_question_button(
1607                     $slot, $displayoptions->readonly);
1608         }
1610         if ($displayoptions->history && $displayoptions->questionreviewlink) {
1611             $links = $this->links_to_other_redos($slot, $displayoptions->questionreviewlink);
1612             if ($links) {
1613                 $displayoptions->extrahistorycontent = html_writer::tag('p',
1614                         get_string('redoesofthisquestion', 'quiz', $renderer->render($links)));
1615             }
1616         }
1618         if ($seq === null) {
1619             $output = $this->quba->render_question($slot, $displayoptions, $number);
1620         } else {
1621             $output = $this->quba->render_question_at_step($slot, $seq, $displayoptions, $number);
1622         }
1624         if ($slot != $originalslot) {
1625             $this->get_question_attempt($slot)->set_max_mark($originalmaxmark);
1626         }
1628         return $output;
1629     }
1631     /**
1632      * Create a fake question to be displayed in place of a question that is blocked
1633      * until the previous question has been answered.
1634      *
1635      * @param int $slot int slot number of the question to replace.
1636      * @return question_definition the placeholde question.
1637      */
1638     protected function make_blocked_question_placeholder($slot) {
1639         $replacedquestion = $this->get_question_attempt($slot)->get_question();
1641         question_bank::load_question_definition_classes('description');
1642         $question = new qtype_description_question();
1643         $question->id = $replacedquestion->id;
1644         $question->category = null;
1645         $question->parent = 0;
1646         $question->qtype = question_bank::get_qtype('description');
1647         $question->name = '';
1648         $question->questiontext = get_string('questiondependsonprevious', 'quiz');
1649         $question->questiontextformat = FORMAT_HTML;
1650         $question->generalfeedback = '';
1651         $question->defaultmark = $this->quba->get_question_max_mark($slot);
1652         $question->length = $replacedquestion->length;
1653         $question->penalty = 0;
1654         $question->stamp = '';
1655         $question->version = 0;
1656         $question->hidden = 0;
1657         $question->timecreated = null;
1658         $question->timemodified = null;
1659         $question->createdby = null;
1660         $question->modifiedby = null;
1662         $placeholderqa = new question_attempt($question, $this->quba->get_id(),
1663                 null, $this->quba->get_question_max_mark($slot));
1664         $placeholderqa->set_slot($slot);
1665         $placeholderqa->start($this->get_quiz()->preferredbehaviour, 1);
1666         $placeholderqa->set_flagged($this->is_question_flagged($slot));
1667         return $placeholderqa;
1668     }
1670     /**
1671      * Like {@link render_question()} but displays the question at the past step
1672      * indicated by $seq, rather than showing the latest step.
1673      *
1674      * @param int $id the id of a question in this quiz attempt.
1675      * @param int $seq the seq number of the past state to display.
1676      * @param bool $reviewing is the being printed on an attempt or a review page.
1677      * @param mod_quiz_renderer $renderer the quiz renderer.
1678      * @param string $thispageurl the URL of the page this question is being printed on.
1679      * @return string HTML for the question in its current state.
1680      */
1681     public function render_question_at_step($slot, $seq, $reviewing, mod_quiz_renderer $renderer, $thispageurl = '') {
1682         return $this->render_question_helper($slot, $reviewing, $thispageurl, $renderer, $seq);
1683     }
1685     /**
1686      * Wrapper round print_question from lib/questionlib.php.
1687      *
1688      * @param int $id the id of a question in this quiz attempt.
1689      */
1690     public function render_question_for_commenting($slot) {
1691         $options = $this->get_display_options(true);
1692         $options->hide_all_feedback();
1693         $options->manualcomment = question_display_options::EDITABLE;
1694         return $this->quba->render_question($slot, $options,
1695                 $this->get_question_number($slot));
1696     }
1698     /**
1699      * Check wheter access should be allowed to a particular file.
1700      *
1701      * @param int $id the id of a question in this quiz attempt.
1702      * @param bool $reviewing is the being printed on an attempt or a review page.
1703      * @param string $thispageurl the URL of the page this question is being printed on.
1704      * @return string HTML for the question in its current state.
1705      */
1706     public function check_file_access($slot, $reviewing, $contextid, $component,
1707             $filearea, $args, $forcedownload) {
1708         $options = $this->get_display_options($reviewing);
1710         // Check permissions - warning there is similar code in review.php and
1711         // reviewquestion.php. If you change on, change them all.
1712         if ($reviewing && $this->is_own_attempt() && !$options->attempt) {
1713             return false;
1714         }
1716         if ($reviewing && !$this->is_own_attempt() && !$this->is_review_allowed()) {
1717             return false;
1718         }
1720         return $this->quba->check_file_access($slot, $options,
1721                 $component, $filearea, $args, $forcedownload);
1722     }
1724     /**
1725      * Get the navigation panel object for this attempt.
1726      *
1727      * @param $panelclass The type of panel, quiz_attempt_nav_panel or quiz_review_nav_panel
1728      * @param $page the current page number.
1729      * @param $showall whether we are showing the whole quiz on one page. (Used by review.php)
1730      * @return quiz_nav_panel_base the requested object.
1731      */
1732     public function get_navigation_panel(mod_quiz_renderer $output,
1733              $panelclass, $page, $showall = false) {
1734         $panel = new $panelclass($this, $this->get_display_options(true), $page, $showall);
1736         $bc = new block_contents();
1737         $bc->attributes['id'] = 'mod_quiz_navblock';
1738         $bc->attributes['role'] = 'navigation';
1739         $bc->attributes['aria-labelledby'] = 'mod_quiz_navblock_title';
1740         $bc->title = html_writer::span(get_string('quiznavigation', 'quiz'), '', array('id' => 'mod_quiz_navblock_title'));
1741         $bc->content = $output->navigation_panel($panel);
1742         return $bc;
1743     }
1745     /**
1746      * Return an array of variant URLs to other attempts at this quiz.
1747      *
1748      * The $url passed in must contain an attempt parameter.
1749      *
1750      * The {@link mod_quiz_links_to_other_attempts} object returned contains an
1751      * array with keys that are the attempt number, 1, 2, 3.
1752      * The array values are either a {@link moodle_url} with the attmept parameter
1753      * updated to point to the attempt id of the other attempt, or null corresponding
1754      * to the current attempt number.
1755      *
1756      * @param moodle_url $url a URL.
1757      * @return mod_quiz_links_to_other_attempts containing array int => null|moodle_url.
1758      */
1759     public function links_to_other_attempts(moodle_url $url) {
1760         $attempts = quiz_get_user_attempts($this->get_quiz()->id, $this->attempt->userid, 'all');
1761         if (count($attempts) <= 1) {
1762             return false;
1763         }
1765         $links = new mod_quiz_links_to_other_attempts();
1766         foreach ($attempts as $at) {
1767             if ($at->id == $this->attempt->id) {
1768                 $links->links[$at->attempt] = null;
1769             } else {
1770                 $links->links[$at->attempt] = new moodle_url($url, array('attempt' => $at->id));
1771             }
1772         }
1773         return $links;
1774     }
1776     /**
1777      * Return an array of variant URLs to other redos of the question in a particular slot.
1778      *
1779      * The $url passed in must contain a slot parameter.
1780      *
1781      * The {@link mod_quiz_links_to_other_attempts} object returned contains an
1782      * array with keys that are the redo number, 1, 2, 3.
1783      * The array values are either a {@link moodle_url} with the slot parameter
1784      * updated to point to the slot that has that redo of this question; or null
1785      * corresponding to the redo identified by $slot.
1786      *
1787      * @param int $slot identifies a question in this attempt.
1788      * @param moodle_url $baseurl the base URL to modify to generate each link.
1789      * @return mod_quiz_links_to_other_attempts|null containing array int => null|moodle_url,
1790      *      or null if the question in this slot has not been redone.
1791      */
1792     public function links_to_other_redos($slot, moodle_url $baseurl) {
1793         $originalslot = $this->get_original_slot($slot);
1795         $qas = $this->all_question_attempts_originally_in_slot($originalslot);
1796         if (count($qas) <= 1) {
1797             return null;
1798         }
1800         $links = new mod_quiz_links_to_other_attempts();
1801         $index = 1;
1802         foreach ($qas as $qa) {
1803             if ($qa->get_slot() == $slot) {
1804                 $links->links[$index] = null;
1805             } else {
1806                 $url = new moodle_url($baseurl, array('slot' => $qa->get_slot()));
1807                 $links->links[$index] = new action_link($url, $index,
1808                         new popup_action('click', $url, 'reviewquestion',
1809                                 array('width' => 450, 'height' => 650)),
1810                         array('title' => get_string('reviewresponse', 'question')));
1811             }
1812             $index++;
1813         }
1814         return $links;
1815     }
1817     // Methods for processing ==================================================
1819     /**
1820      * Check this attempt, to see if there are any state transitions that should
1821      * happen automatically.  This function will update the attempt checkstatetime.
1822      * @param int $timestamp the timestamp that should be stored as the modifed
1823      * @param bool $studentisonline is the student currently interacting with Moodle?
1824      */
1825     public function handle_if_time_expired($timestamp, $studentisonline) {
1826         global $DB;
1828         $timeclose = $this->get_access_manager($timestamp)->get_end_time($this->attempt);
1830         if ($timeclose === false || $this->is_preview()) {
1831             $this->update_timecheckstate(null);
1832             return; // No time limit
1833         }
1834         if ($timestamp < $timeclose) {
1835             $this->update_timecheckstate($timeclose);
1836             return; // Time has not yet expired.
1837         }
1839         // If the attempt is already overdue, look to see if it should be abandoned ...
1840         if ($this->attempt->state == self::OVERDUE) {
1841             $timeoverdue = $timestamp - $timeclose;
1842             $graceperiod = $this->quizobj->get_quiz()->graceperiod;
1843             if ($timeoverdue >= $graceperiod) {
1844                 $this->process_abandon($timestamp, $studentisonline);
1845             } else {
1846                 // Overdue time has not yet expired
1847                 $this->update_timecheckstate($timeclose + $graceperiod);
1848             }
1849             return; // ... and we are done.
1850         }
1852         if ($this->attempt->state != self::IN_PROGRESS) {
1853             $this->update_timecheckstate(null);
1854             return; // Attempt is already in a final state.
1855         }
1857         // Otherwise, we were in quiz_attempt::IN_PROGRESS, and time has now expired.
1858         // Transition to the appropriate state.
1859         switch ($this->quizobj->get_quiz()->overduehandling) {
1860             case 'autosubmit':
1861                 $this->process_finish($timestamp, false);
1862                 return;
1864             case 'graceperiod':
1865                 $this->process_going_overdue($timestamp, $studentisonline);
1866                 return;
1868             case 'autoabandon':
1869                 $this->process_abandon($timestamp, $studentisonline);
1870                 return;
1871         }
1873         // This is an overdue attempt with no overdue handling defined, so just abandon.
1874         $this->process_abandon($timestamp, $studentisonline);
1875         return;
1876     }
1878     /**
1879      * Process all the actions that were submitted as part of the current request.
1880      *
1881      * @param int  $timestamp  the timestamp that should be stored as the modifed
1882      *                         time in the database for these actions. If null, will use the current time.
1883      * @param bool $becomingoverdue
1884      * @param array|null $simulatedresponses If not null, then we are testing, and this is an array of simulated data.
1885      *      There are two formats supported here, for historical reasons. The newer approach is to pass an array created by
1886      *      {@link core_question_generator::get_simulated_post_data_for_questions_in_usage()}.
1887      *      the second is to pass an array slot no => contains arrays representing student
1888      *      responses which will be passed to {@link question_definition::prepare_simulated_post_data()}.
1889      *      This second method will probably get deprecated one day.
1890      */
1891     public function process_submitted_actions($timestamp, $becomingoverdue = false, $simulatedresponses = null) {
1892         global $DB;
1894         $transaction = $DB->start_delegated_transaction();
1896         if ($simulatedresponses !== null) {
1897             if (is_int(key($simulatedresponses))) {
1898                 // Legacy approach. Should be removed one day.
1899                 $simulatedpostdata = $this->quba->prepare_simulated_post_data($simulatedresponses);
1900             } else {
1901                 $simulatedpostdata = $simulatedresponses;
1902             }
1903         } else {
1904             $simulatedpostdata = null;
1905         }
1907         $this->quba->process_all_actions($timestamp, $simulatedpostdata);
1908         question_engine::save_questions_usage_by_activity($this->quba);
1910         $this->attempt->timemodified = $timestamp;
1911         if ($this->attempt->state == self::FINISHED) {
1912             $this->attempt->sumgrades = $this->quba->get_total_mark();
1913         }
1914         if ($becomingoverdue) {
1915             $this->process_going_overdue($timestamp, true);
1916         } else {
1917             $DB->update_record('quiz_attempts', $this->attempt);
1918         }
1920         if (!$this->is_preview() && $this->attempt->state == self::FINISHED) {
1921             quiz_save_best_grade($this->get_quiz(), $this->get_userid());
1922         }
1924         $transaction->allow_commit();
1925     }
1927     /**
1928      * Replace a question in an attempt with a new attempt at the same question.
1929      *
1930      * Well, for randomised questions, it won't be the same question, it will be
1931      * a different randomised selection.
1932      *
1933      * @param int $slot the question to restart.
1934      * @param int $timestamp the timestamp to record for this action.
1935      */
1936     public function process_redo_question($slot, $timestamp) {
1937         global $DB;
1939         if (!$this->can_question_be_redone_now($slot)) {
1940             throw new coding_exception('Attempt to restart the question in slot ' . $slot .
1941                     ' when it is not in a state to be restarted.');
1942         }
1944         $qubaids = new \mod_quiz\question\qubaids_for_users_attempts(
1945                 $this->get_quizid(), $this->get_userid(), 'all', true);
1947         $transaction = $DB->start_delegated_transaction();
1949         // Choose the replacement question.
1950         $questiondata = $DB->get_record('question',
1951                 array('id' => $this->slots[$slot]->questionid));
1952         if ($questiondata->qtype != 'random') {
1953             $newqusetionid = $questiondata->id;
1954         } else {
1955             $tagids = quiz_retrieve_slot_tag_ids($this->slots[$slot]->id);
1957             $randomloader = new \core_question\bank\random_question_loader($qubaids, array());
1958             $newqusetionid = $randomloader->get_next_question_id($questiondata->category,
1959                     (bool) $questiondata->questiontext, $tagids);
1960             if ($newqusetionid === null) {
1961                 throw new moodle_exception('notenoughrandomquestions', 'quiz',
1962                         $this->quizobj->view_url(), $questiondata);
1963             }
1964         }
1966         // Add the question to the usage. It is important we do this before we choose a variant.
1967         $newquestion = question_bank::load_question($newqusetionid);
1968         $newslot = $this->quba->add_question_in_place_of_other($slot, $newquestion);
1970         // Choose the variant.
1971         if ($newquestion->get_num_variants() == 1) {
1972             $variant = 1;
1973         } else {
1974             $variantstrategy = new core_question\engine\variants\least_used_strategy(
1975                     $this->quba, $qubaids);
1976             $variant = $variantstrategy->choose_variant($newquestion->get_num_variants(),
1977                     $newquestion->get_variants_selection_seed());
1978         }
1980         // Start the question.
1981         $this->quba->start_question($slot, $variant);
1982         $this->quba->set_max_mark($newslot, 0);
1983         $this->quba->set_question_attempt_metadata($newslot, 'originalslot', $slot);
1984         question_engine::save_questions_usage_by_activity($this->quba);
1986         $transaction->allow_commit();
1987     }
1989     /**
1990      * Process all the autosaved data that was part of the current request.
1991      *
1992      * @param int $timestamp the timestamp that should be stored as the modifed
1993      * time in the database for these actions. If null, will use the current time.
1994      */
1995     public function process_auto_save($timestamp) {
1996         global $DB;
1998         $transaction = $DB->start_delegated_transaction();
2000         $this->quba->process_all_autosaves($timestamp);
2001         question_engine::save_questions_usage_by_activity($this->quba);
2003         $transaction->allow_commit();
2004     }
2006     /**
2007      * Update the flagged state for all question_attempts in this usage, if their
2008      * flagged state was changed in the request.
2009      */
2010     public function save_question_flags() {
2011         global $DB;
2013         $transaction = $DB->start_delegated_transaction();
2014         $this->quba->update_question_flags();
2015         question_engine::save_questions_usage_by_activity($this->quba);
2016         $transaction->allow_commit();
2017     }
2019     public function process_finish($timestamp, $processsubmitted) {
2020         global $DB;
2022         $transaction = $DB->start_delegated_transaction();
2024         if ($processsubmitted) {
2025             $this->quba->process_all_actions($timestamp);
2026         }
2027         $this->quba->finish_all_questions($timestamp);
2029         question_engine::save_questions_usage_by_activity($this->quba);
2031         $this->attempt->timemodified = $timestamp;
2032         $this->attempt->timefinish = $timestamp;
2033         $this->attempt->sumgrades = $this->quba->get_total_mark();
2034         $this->attempt->state = self::FINISHED;
2035         $this->attempt->timecheckstate = null;
2036         $DB->update_record('quiz_attempts', $this->attempt);
2038         if (!$this->is_preview()) {
2039             quiz_save_best_grade($this->get_quiz(), $this->attempt->userid);
2041             // Trigger event.
2042             $this->fire_state_transition_event('\mod_quiz\event\attempt_submitted', $timestamp);
2044             // Tell any access rules that care that the attempt is over.
2045             $this->get_access_manager($timestamp)->current_attempt_finished();
2046         }
2048         $transaction->allow_commit();
2049     }
2051     /**
2052      * Update this attempt timecheckstate if necessary.
2053      * @param int|null the timecheckstate
2054      */
2055     public function update_timecheckstate($time) {
2056         global $DB;
2057         if ($this->attempt->timecheckstate !== $time) {
2058             $this->attempt->timecheckstate = $time;
2059             $DB->set_field('quiz_attempts', 'timecheckstate', $time, array('id' => $this->attempt->id));
2060         }
2061     }
2063     /**
2064      * Mark this attempt as now overdue.
2065      * @param int $timestamp the time to deem as now.
2066      * @param bool $studentisonline is the student currently interacting with Moodle?
2067      */
2068     public function process_going_overdue($timestamp, $studentisonline) {
2069         global $DB;
2071         $transaction = $DB->start_delegated_transaction();
2072         $this->attempt->timemodified = $timestamp;
2073         $this->attempt->state = self::OVERDUE;
2074         // If we knew the attempt close time, we could compute when the graceperiod ends.
2075         // Instead we'll just fix it up through cron.
2076         $this->attempt->timecheckstate = $timestamp;
2077         $DB->update_record('quiz_attempts', $this->attempt);
2079         $this->fire_state_transition_event('\mod_quiz\event\attempt_becameoverdue', $timestamp);
2081         $transaction->allow_commit();
2083         quiz_send_overdue_message($this);
2084     }
2086     /**
2087      * Mark this attempt as abandoned.
2088      * @param int $timestamp the time to deem as now.
2089      * @param bool $studentisonline is the student currently interacting with Moodle?
2090      */
2091     public function process_abandon($timestamp, $studentisonline) {
2092         global $DB;
2094         $transaction = $DB->start_delegated_transaction();
2095         $this->attempt->timemodified = $timestamp;
2096         $this->attempt->state = self::ABANDONED;
2097         $this->attempt->timecheckstate = null;
2098         $DB->update_record('quiz_attempts', $this->attempt);
2100         $this->fire_state_transition_event('\mod_quiz\event\attempt_abandoned', $timestamp);
2102         $transaction->allow_commit();
2103     }
2105     /**
2106      * Fire a state transition event.
2107      * the same event information.
2108      * @param string $eventclass the event class name.
2109      * @param int $timestamp the timestamp to include in the event.
2110      * @return void
2111      */
2112     protected function fire_state_transition_event($eventclass, $timestamp) {
2113         global $USER;
2114         $quizrecord = $this->get_quiz();
2115         $params = array(
2116             'context' => $this->get_quizobj()->get_context(),
2117             'courseid' => $this->get_courseid(),
2118             'objectid' => $this->attempt->id,
2119             'relateduserid' => $this->attempt->userid,
2120             'other' => array(
2121                 'submitterid' => CLI_SCRIPT ? null : $USER->id,
2122                 'quizid' => $quizrecord->id
2123             )
2124         );
2126         $event = $eventclass::create($params);
2127         $event->add_record_snapshot('quiz', $this->get_quiz());
2128         $event->add_record_snapshot('quiz_attempts', $this->get_attempt());
2129         $event->trigger();
2130     }
2132     // Private methods =========================================================
2134     /**
2135      * Get a URL for a particular question on a particular page of the quiz.
2136      * Used by {@link attempt_url()} and {@link review_url()}.
2137      *
2138      * @param string $script. Used in the URL like /mod/quiz/$script.php
2139      * @param int $slot identifies the specific question on the page to jump to.
2140      *      0 to just use the $page parameter.
2141      * @param int $page -1 to look up the page number from the slot, otherwise
2142      *      the page number to go to.
2143      * @param bool|null $showall if true, return a URL with showall=1, and not page number.
2144      *      if null, then an intelligent default will be chosen.
2145      * @param int $thispage the page we are currently on. Links to questions on this
2146      *      page will just be a fragment #q123. -1 to disable this.
2147      * @return The requested URL.
2148      */
2149     protected function page_and_question_url($script, $slot, $page, $showall, $thispage) {
2151         $defaultshowall = $this->get_default_show_all($script);
2152         if ($showall === null && ($page == 0 || $page == -1)) {
2153             $showall = $defaultshowall;
2154         }
2156         // Fix up $page.
2157         if ($page == -1) {
2158             if ($slot !== null && !$showall) {
2159                 $page = $this->get_question_page($slot);
2160             } else {
2161                 $page = 0;
2162             }
2163         }
2165         if ($showall) {
2166             $page = 0;
2167         }
2169         // Add a fragment to scroll down to the question.
2170         $fragment = '';
2171         if ($slot !== null) {
2172             if ($slot == reset($this->pagelayout[$page])) {
2173                 // First question on page, go to top.
2174                 $fragment = '#';
2175             } else {
2176                 $qa = $this->get_question_attempt($slot);
2177                 $fragment = '#' . $qa->get_outer_question_div_unique_id();
2178             }
2179         }
2181         // Work out the correct start to the URL.
2182         if ($thispage == $page) {
2183             return new moodle_url($fragment);
2185         } else {
2186             $url = new moodle_url('/mod/quiz/' . $script . '.php' . $fragment,
2187                     array('attempt' => $this->attempt->id, 'cmid' => $this->get_cmid()));
2188             if ($page == 0 && $showall != $defaultshowall) {
2189                 $url->param('showall', (int) $showall);
2190             } else if ($page > 0) {
2191                 $url->param('page', $page);
2192             }
2193             return $url;
2194         }
2195     }
2197     /**
2198      * Process responses during an attempt at a quiz.
2199      *
2200      * @param  int $timenow time when the processing started
2201      * @param  bool $finishattempt whether to finish the attempt or not
2202      * @param  bool $timeup true if form was submitted by timer
2203      * @param  int $thispage current page number
2204      * @return string the attempt state once the data has been processed
2205      * @since  Moodle 3.1
2206      * @throws  moodle_exception
2207      */
2208     public function process_attempt($timenow, $finishattempt, $timeup, $thispage) {
2209         global $DB;
2211         $transaction = $DB->start_delegated_transaction();
2213         // If there is only a very small amount of time left, there is no point trying
2214         // to show the student another page of the quiz. Just finish now.
2215         $graceperiodmin = null;
2216         $accessmanager = $this->get_access_manager($timenow);
2217         $timeclose = $accessmanager->get_end_time($this->get_attempt());
2219         // Don't enforce timeclose for previews.
2220         if ($this->is_preview()) {
2221             $timeclose = false;
2222         }
2223         $toolate = false;
2224         if ($timeclose !== false && $timenow > $timeclose - QUIZ_MIN_TIME_TO_CONTINUE) {
2225             $timeup = true;
2226             $graceperiodmin = get_config('quiz', 'graceperiodmin');
2227             if ($timenow > $timeclose + $graceperiodmin) {
2228                 $toolate = true;
2229             }
2230         }
2232         // If time is running out, trigger the appropriate action.
2233         $becomingoverdue = false;
2234         $becomingabandoned = false;
2235         if ($timeup) {
2236             if ($this->get_quiz()->overduehandling == 'graceperiod') {
2237                 if (is_null($graceperiodmin)) {
2238                     $graceperiodmin = get_config('quiz', 'graceperiodmin');
2239                 }
2240                 if ($timenow > $timeclose + $this->get_quiz()->graceperiod + $graceperiodmin) {
2241                     // Grace period has run out.
2242                     $finishattempt = true;
2243                     $becomingabandoned = true;
2244                 } else {
2245                     $becomingoverdue = true;
2246                 }
2247             } else {
2248                 $finishattempt = true;
2249             }
2250         }
2252         // Don't log - we will end with a redirect to a page that is logged.
2254         if (!$finishattempt) {
2255             // Just process the responses for this page and go to the next page.
2256             if (!$toolate) {
2257                 try {
2258                     $this->process_submitted_actions($timenow, $becomingoverdue);
2260                 } catch (question_out_of_sequence_exception $e) {
2261                     throw new moodle_exception('submissionoutofsequencefriendlymessage', 'question',
2262                             $this->attempt_url(null, $thispage));
2264                 } catch (Exception $e) {
2265                     // This sucks, if we display our own custom error message, there is no way
2266                     // to display the original stack trace.
2267                     $debuginfo = '';
2268                     if (!empty($e->debuginfo)) {
2269                         $debuginfo = $e->debuginfo;
2270                     }
2271                     throw new moodle_exception('errorprocessingresponses', 'question',
2272                             $this->attempt_url(null, $thispage), $e->getMessage(), $debuginfo);
2273                 }
2275                 if (!$becomingoverdue) {
2276                     foreach ($this->get_slots() as $slot) {
2277                         if (optional_param('redoslot' . $slot, false, PARAM_BOOL)) {
2278                             $this->process_redo_question($slot, $timenow);
2279                         }
2280                     }
2281                 }
2283             } else {
2284                 // The student is too late.
2285                 $this->process_going_overdue($timenow, true);
2286             }
2288             $transaction->allow_commit();
2290             return $becomingoverdue ? self::OVERDUE : self::IN_PROGRESS;
2291         }
2293         // Update the quiz attempt record.
2294         try {
2295             if ($becomingabandoned) {
2296                 $this->process_abandon($timenow, true);
2297             } else {
2298                 $this->process_finish($timenow, !$toolate);
2299             }
2301         } catch (question_out_of_sequence_exception $e) {
2302             throw new moodle_exception('submissionoutofsequencefriendlymessage', 'question',
2303                     $this->attempt_url(null, $thispage));
2305         } catch (Exception $e) {
2306             // This sucks, if we display our own custom error message, there is no way
2307             // to display the original stack trace.
2308             $debuginfo = '';
2309             if (!empty($e->debuginfo)) {
2310                 $debuginfo = $e->debuginfo;
2311             }
2312             throw new moodle_exception('errorprocessingresponses', 'question',
2313                     $this->attempt_url(null, $thispage), $e->getMessage(), $debuginfo);
2314         }
2316         // Send the user to the review page.
2317         $transaction->allow_commit();
2319         return $becomingabandoned ? self::ABANDONED : self::FINISHED;
2320     }
2322     /**
2323      * Check a page access to see if is an out of sequence access.
2324      *
2325      * @param  int $page page number
2326      * @return boolean false is is an out of sequence access, true otherwise.
2327      * @since Moodle 3.1
2328      */
2329     public function check_page_access($page) {
2330         global $DB;
2332         if ($this->get_currentpage() != $page) {
2333             if ($this->get_navigation_method() == QUIZ_NAVMETHOD_SEQ && $this->get_currentpage() > $page) {
2334                 return false;
2335             }
2336         }
2337         return true;
2338     }
2340     /**
2341      * Update attempt page.
2342      *
2343      * @param  int $page page number
2344      * @return boolean true if everything was ok, false otherwise (out of sequence access).
2345      * @since Moodle 3.1
2346      */
2347     public function set_currentpage($page) {
2348         global $DB;
2350         if ($this->check_page_access($page)) {
2351             $DB->set_field('quiz_attempts', 'currentpage', $page, array('id' => $this->get_attemptid()));
2352             return true;
2353         }
2354         return false;
2355     }
2357     /**
2358      * Trigger the attempt_viewed event.
2359      *
2360      * @since Moodle 3.1
2361      */
2362     public function fire_attempt_viewed_event() {
2363         $params = array(
2364             'objectid' => $this->get_attemptid(),
2365             'relateduserid' => $this->get_userid(),
2366             'courseid' => $this->get_courseid(),
2367             'context' => context_module::instance($this->get_cmid()),
2368             'other' => array(
2369                 'quizid' => $this->get_quizid()
2370             )
2371         );
2372         $event = \mod_quiz\event\attempt_viewed::create($params);
2373         $event->add_record_snapshot('quiz_attempts', $this->get_attempt());
2374         $event->trigger();
2375     }
2377     /**
2378      * Trigger the attempt_summary_viewed event.
2379      *
2380      * @since Moodle 3.1
2381      */
2382     public function fire_attempt_summary_viewed_event() {
2384         $params = array(
2385             'objectid' => $this->get_attemptid(),
2386             'relateduserid' => $this->get_userid(),
2387             'courseid' => $this->get_courseid(),
2388             'context' => context_module::instance($this->get_cmid()),
2389             'other' => array(
2390                 'quizid' => $this->get_quizid()
2391             )
2392         );
2393         $event = \mod_quiz\event\attempt_summary_viewed::create($params);
2394         $event->add_record_snapshot('quiz_attempts', $this->get_attempt());
2395         $event->trigger();
2396     }
2398     /**
2399      * Trigger the attempt_reviewed event.
2400      *
2401      * @since Moodle 3.1
2402      */
2403     public function fire_attempt_reviewed_event() {
2405         $params = array(
2406             'objectid' => $this->get_attemptid(),
2407             'relateduserid' => $this->get_userid(),
2408             'courseid' => $this->get_courseid(),
2409             'context' => context_module::instance($this->get_cmid()),
2410             'other' => array(
2411                 'quizid' => $this->get_quizid()
2412             )
2413         );
2414         $event = \mod_quiz\event\attempt_reviewed::create($params);
2415         $event->add_record_snapshot('quiz_attempts', $this->get_attempt());
2416         $event->trigger();
2417     }
2419     /**
2420      * Update the timemodifiedoffline attempt field.
2421      * This function should be used only when web services are being used.
2422      *
2423      * @param int $time time stamp
2424      * @return boolean false if the field is not updated because web services aren't being used.
2425      * @since Moodle 3.2
2426      */
2427     public function set_offline_modified_time($time) {
2428         global $DB;
2430         // Update the timemodifiedoffline field only if web services are being used.
2431         if (WS_SERVER) {
2432             $this->attempt->timemodifiedoffline = $time;
2433             return true;
2434         }
2435         return false;
2436     }
2441 /**
2442  * Represents a heading in the navigation panel.
2443  *
2444  * @copyright  2015 The Open University
2445  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2446  * @since      Moodle 2.9
2447  */
2448 class quiz_nav_section_heading implements renderable {
2449     /** @var string the heading text. */
2450     public $heading;
2452     /**
2453      * Constructor.
2454      * @param string $heading the heading text
2455      */
2456     public function __construct($heading) {
2457         $this->heading = $heading;
2458     }
2462 /**
2463  * Represents a single link in the navigation panel.
2464  *
2465  * @copyright  2011 The Open University
2466  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2467  * @since      Moodle 2.1
2468  */
2469 class quiz_nav_question_button implements renderable {
2470     /** @var string id="..." to add to the HTML for this button. */
2471     public $id;
2472     /** @var string number to display in this button. Either the question number of 'i'. */
2473     public $number;
2474     /** @var string class to add to the class="" attribute to represnt the question state. */
2475     public $stateclass;
2476     /** @var string Textual description of the question state, e.g. to use as a tool tip. */
2477     public $statestring;
2478     /** @var int the page number this question is on. */
2479     public $page;
2480     /** @var bool true if this question is on the current page. */
2481     public $currentpage;
2482     /** @var bool true if this question has been flagged. */
2483     public $flagged;
2484     /** @var moodle_url the link this button goes to, or null if there should not be a link. */
2485     public $url;
2489 /**
2490  * Represents the navigation panel, and builds a {@link block_contents} to allow
2491  * it to be output.
2492  *
2493  * @copyright  2008 Tim Hunt
2494  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2495  * @since      Moodle 2.0
2496  */
2497 abstract class quiz_nav_panel_base {
2498     /** @var quiz_attempt */
2499     protected $attemptobj;
2500     /** @var question_display_options */
2501     protected $options;
2502     /** @var integer */
2503     protected $page;
2504     /** @var boolean */
2505     protected $showall;
2507     public function __construct(quiz_attempt $attemptobj,
2508             question_display_options $options, $page, $showall) {
2509         $this->attemptobj = $attemptobj;
2510         $this->options = $options;
2511         $this->page = $page;
2512         $this->showall = $showall;
2513     }
2515     /**
2516      * Get the buttons and section headings to go in the quiz navigation block.
2517      * @return renderable[] the buttons, possibly interleaved with section headings.
2518      */
2519     public function get_question_buttons() {
2520         $buttons = array();
2521         foreach ($this->attemptobj->get_slots() as $slot) {
2522             if ($heading = $this->attemptobj->get_heading_before_slot($slot)) {
2523                 $buttons[] = new quiz_nav_section_heading(format_string($heading));
2524             }
2526             $qa = $this->attemptobj->get_question_attempt($slot);
2527             $showcorrectness = $this->options->correctness && $qa->has_marks();
2529             $button = new quiz_nav_question_button();
2530             $button->id          = 'quiznavbutton' . $slot;
2531             $button->number      = $this->attemptobj->get_question_number($slot);
2532             $button->stateclass  = $qa->get_state_class($showcorrectness);
2533             $button->navmethod   = $this->attemptobj->get_navigation_method();
2534             if (!$showcorrectness && $button->stateclass == 'notanswered') {
2535                 $button->stateclass = 'complete';
2536             }
2537             $button->statestring = $this->get_state_string($qa, $showcorrectness);
2538             $button->page        = $this->attemptobj->get_question_page($slot);
2539             $button->currentpage = $this->showall || $button->page == $this->page;
2540             $button->flagged     = $qa->is_flagged();
2541             $button->url         = $this->get_question_url($slot);
2542             if ($this->attemptobj->is_blocked_by_previous_question($slot)) {
2543                 $button->url = null;
2544                 $button->stateclass = 'blocked';
2545                 $button->statestring = get_string('questiondependsonprevious', 'quiz');
2546             }
2547             $buttons[] = $button;
2548         }
2550         return $buttons;
2551     }
2553     protected function get_state_string(question_attempt $qa, $showcorrectness) {
2554         if ($qa->get_question()->length > 0) {
2555             return $qa->get_state_string($showcorrectness);
2556         }
2558         // Special case handling for 'information' items.
2559         if ($qa->get_state() == question_state::$todo) {
2560             return get_string('notyetviewed', 'quiz');
2561         } else {
2562             return get_string('viewed', 'quiz');
2563         }
2564     }
2566     public function render_before_button_bits(mod_quiz_renderer $output) {
2567         return '';
2568     }
2570     abstract public function render_end_bits(mod_quiz_renderer $output);
2572     protected function render_restart_preview_link($output) {
2573         if (!$this->attemptobj->is_own_preview()) {
2574             return '';
2575         }
2576         return $output->restart_preview_button(new moodle_url(
2577                 $this->attemptobj->start_attempt_url(), array('forcenew' => true)));
2578     }
2580     protected abstract function get_question_url($slot);
2582     public function user_picture() {
2583         global $DB;
2584         if ($this->attemptobj->get_quiz()->showuserpicture == QUIZ_SHOWIMAGE_NONE) {
2585             return null;
2586         }
2587         $user = $DB->get_record('user', array('id' => $this->attemptobj->get_userid()));
2588         $userpicture = new user_picture($user);
2589         $userpicture->courseid = $this->attemptobj->get_courseid();
2590         if ($this->attemptobj->get_quiz()->showuserpicture == QUIZ_SHOWIMAGE_LARGE) {
2591             $userpicture->size = true;
2592         }
2593         return $userpicture;
2594     }
2596     /**
2597      * Return 'allquestionsononepage' as CSS class name when $showall is set,
2598      * otherwise, return 'multipages' as CSS class name.
2599      * @return string, CSS class name
2600      */
2601     public function get_button_container_class() {
2602         // Quiz navigation is set on 'Show all questions on one page'.
2603         if ($this->showall) {
2604             return 'allquestionsononepage';
2605         }
2606         // Quiz navigation is set on 'Show one page at a time'.
2607         return 'multipages';
2608     }
2612 /**
2613  * Specialisation of {@link quiz_nav_panel_base} for the attempt quiz page.
2614  *
2615  * @copyright  2008 Tim Hunt
2616  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2617  * @since      Moodle 2.0
2618  */
2619 class quiz_attempt_nav_panel extends quiz_nav_panel_base {
2620     public function get_question_url($slot) {
2621         if ($this->attemptobj->can_navigate_to($slot)) {
2622             return $this->attemptobj->attempt_url($slot, -1, $this->page);
2623         } else {
2624             return null;
2625         }
2626     }
2628     public function render_before_button_bits(mod_quiz_renderer $output) {
2629         return html_writer::tag('div', get_string('navnojswarning', 'quiz'),
2630                 array('id' => 'quiznojswarning'));
2631     }
2633     public function render_end_bits(mod_quiz_renderer $output) {
2634         return html_writer::link($this->attemptobj->summary_url(),
2635                 get_string('endtest', 'quiz'), array('class' => 'endtestlink')) .
2636                 $output->countdown_timer($this->attemptobj, time()) .
2637                 $this->render_restart_preview_link($output);
2638     }
2642 /**
2643  * Specialisation of {@link quiz_nav_panel_base} for the review quiz page.
2644  *
2645  * @copyright  2008 Tim Hunt
2646  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2647  * @since      Moodle 2.0
2648  */
2649 class quiz_review_nav_panel extends quiz_nav_panel_base {
2650     public function get_question_url($slot) {
2651         return $this->attemptobj->review_url($slot, -1, $this->showall, $this->page);
2652     }
2654     public function render_end_bits(mod_quiz_renderer $output) {
2655         $html = '';
2656         if ($this->attemptobj->get_num_pages() > 1) {
2657             if ($this->showall) {
2658                 $html .= html_writer::link($this->attemptobj->review_url(null, 0, false),
2659                         get_string('showeachpage', 'quiz'));
2660             } else {
2661                 $html .= html_writer::link($this->attemptobj->review_url(null, 0, true),
2662                         get_string('showall', 'quiz'));
2663             }
2664         }
2665         $html .= $output->finish_review_link($this->attemptobj);
2666         $html .= $this->render_restart_preview_link($output);
2667         return $html;
2668     }