Merge branch 'MDL-52888-master' of git://github.com/jleyva/moodle
[moodle.git] / mod / quiz / locallib.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  * Library of functions used by the quiz module.
19  *
20  * This contains functions that are called from within the quiz module only
21  * Functions that are also called by core Moodle are in {@link lib.php}
22  * This script also loads the code in {@link questionlib.php} which holds
23  * the module-indpendent code for handling questions and which in turn
24  * initialises all the questiontype classes.
25  *
26  * @package    mod_quiz
27  * @copyright  1999 onwards Martin Dougiamas and others {@link http://moodle.com}
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
32 defined('MOODLE_INTERNAL') || die();
34 require_once($CFG->dirroot . '/mod/quiz/lib.php');
35 require_once($CFG->dirroot . '/mod/quiz/accessmanager.php');
36 require_once($CFG->dirroot . '/mod/quiz/accessmanager_form.php');
37 require_once($CFG->dirroot . '/mod/quiz/renderer.php');
38 require_once($CFG->dirroot . '/mod/quiz/attemptlib.php');
39 require_once($CFG->libdir . '/completionlib.php');
40 require_once($CFG->libdir . '/eventslib.php');
41 require_once($CFG->libdir . '/filelib.php');
42 require_once($CFG->libdir . '/questionlib.php');
45 /**
46  * @var int We show the countdown timer if there is less than this amount of time left before the
47  * the quiz close date. (1 hour)
48  */
49 define('QUIZ_SHOW_TIME_BEFORE_DEADLINE', '3600');
51 /**
52  * @var int If there are fewer than this many seconds left when the student submits
53  * a page of the quiz, then do not take them to the next page of the quiz. Instead
54  * close the quiz immediately.
55  */
56 define('QUIZ_MIN_TIME_TO_CONTINUE', '2');
58 /**
59  * @var int We show no image when user selects No image from dropdown menu in quiz settings.
60  */
61 define('QUIZ_SHOWIMAGE_NONE', 0);
63 /**
64  * @var int We show small image when user selects small image from dropdown menu in quiz settings.
65  */
66 define('QUIZ_SHOWIMAGE_SMALL', 1);
68 /**
69  * @var int We show Large image when user selects Large image from dropdown menu in quiz settings.
70  */
71 define('QUIZ_SHOWIMAGE_LARGE', 2);
74 // Functions related to attempts ///////////////////////////////////////////////
76 /**
77  * Creates an object to represent a new attempt at a quiz
78  *
79  * Creates an attempt object to represent an attempt at the quiz by the current
80  * user starting at the current time. The ->id field is not set. The object is
81  * NOT written to the database.
82  *
83  * @param object $quizobj the quiz object to create an attempt for.
84  * @param int $attemptnumber the sequence number for the attempt.
85  * @param object $lastattempt the previous attempt by this user, if any. Only needed
86  *         if $attemptnumber > 1 and $quiz->attemptonlast is true.
87  * @param int $timenow the time the attempt was started at.
88  * @param bool $ispreview whether this new attempt is a preview.
89  * @param int $userid  the id of the user attempting this quiz.
90  *
91  * @return object the newly created attempt object.
92  */
93 function quiz_create_attempt(quiz $quizobj, $attemptnumber, $lastattempt, $timenow, $ispreview = false, $userid = null) {
94     global $USER;
96     if ($userid === null) {
97         $userid = $USER->id;
98     }
100     $quiz = $quizobj->get_quiz();
101     if ($quiz->sumgrades < 0.000005 && $quiz->grade > 0.000005) {
102         throw new moodle_exception('cannotstartgradesmismatch', 'quiz',
103                 new moodle_url('/mod/quiz/view.php', array('q' => $quiz->id)),
104                     array('grade' => quiz_format_grade($quiz, $quiz->grade)));
105     }
107     if ($attemptnumber == 1 || !$quiz->attemptonlast) {
108         // We are not building on last attempt so create a new attempt.
109         $attempt = new stdClass();
110         $attempt->quiz = $quiz->id;
111         $attempt->userid = $userid;
112         $attempt->preview = 0;
113         $attempt->layout = '';
114     } else {
115         // Build on last attempt.
116         if (empty($lastattempt)) {
117             print_error('cannotfindprevattempt', 'quiz');
118         }
119         $attempt = $lastattempt;
120     }
122     $attempt->attempt = $attemptnumber;
123     $attempt->timestart = $timenow;
124     $attempt->timefinish = 0;
125     $attempt->timemodified = $timenow;
126     $attempt->state = quiz_attempt::IN_PROGRESS;
127     $attempt->currentpage = 0;
128     $attempt->sumgrades = null;
130     // If this is a preview, mark it as such.
131     if ($ispreview) {
132         $attempt->preview = 1;
133     }
135     $timeclose = $quizobj->get_access_manager($timenow)->get_end_time($attempt);
136     if ($timeclose === false || $ispreview) {
137         $attempt->timecheckstate = null;
138     } else {
139         $attempt->timecheckstate = $timeclose;
140     }
142     return $attempt;
144 /**
145  * Start a normal, new, quiz attempt.
146  *
147  * @param quiz      $quizobj            the quiz object to start an attempt for.
148  * @param question_usage_by_activity $quba
149  * @param object    $attempt
150  * @param integer   $attemptnumber      starting from 1
151  * @param integer   $timenow            the attempt start time
152  * @param array     $questionids        slot number => question id. Used for random questions, to force the choice
153  *                                        of a particular actual question. Intended for testing purposes only.
154  * @param array     $forcedvariantsbyslot slot number => variant. Used for questions with variants,
155  *                                          to force the choice of a particular variant. Intended for testing
156  *                                          purposes only.
157  * @throws moodle_exception
158  * @return object   modified attempt object
159  */
160 function quiz_start_new_attempt($quizobj, $quba, $attempt, $attemptnumber, $timenow,
161                                 $questionids = array(), $forcedvariantsbyslot = array()) {
163     // Usages for this user's previous quiz attempts.
164     $qubaids = new \mod_quiz\question\qubaids_for_users_attempts(
165             $quizobj->get_quizid(), $attempt->userid);
167     // Fully load all the questions in this quiz.
168     $quizobj->preload_questions();
169     $quizobj->load_questions();
171     // First load all the non-random questions.
172     $randomfound = false;
173     $slot = 0;
174     $questions = array();
175     $maxmark = array();
176     $page = array();
177     foreach ($quizobj->get_questions() as $questiondata) {
178         $slot += 1;
179         $maxmark[$slot] = $questiondata->maxmark;
180         $page[$slot] = $questiondata->page;
181         if ($questiondata->qtype == 'random') {
182             $randomfound = true;
183             continue;
184         }
185         if (!$quizobj->get_quiz()->shuffleanswers) {
186             $questiondata->options->shuffleanswers = false;
187         }
188         $questions[$slot] = question_bank::make_question($questiondata);
189     }
191     // Then find a question to go in place of each random question.
192     if ($randomfound) {
193         $slot = 0;
194         $usedquestionids = array();
195         foreach ($questions as $question) {
196             if (isset($usedquestions[$question->id])) {
197                 $usedquestionids[$question->id] += 1;
198             } else {
199                 $usedquestionids[$question->id] = 1;
200             }
201         }
202         $randomloader = new \core_question\bank\random_question_loader($qubaids, $usedquestionids);
204         foreach ($quizobj->get_questions() as $questiondata) {
205             $slot += 1;
206             if ($questiondata->qtype != 'random') {
207                 continue;
208             }
210             // Deal with fixed random choices for testing.
211             if (isset($questionids[$quba->next_slot_number()])) {
212                 if ($randomloader->is_question_available($questiondata->category,
213                         (bool) $questiondata->questiontext, $questionids[$quba->next_slot_number()])) {
214                     $questions[$slot] = question_bank::load_question(
215                             $questionids[$quba->next_slot_number()], $quizobj->get_quiz()->shuffleanswers);
216                     continue;
217                 } else {
218                     throw new coding_exception('Forced question id not available.');
219                 }
220             }
222             // Normal case, pick one at random.
223             $questionid = $randomloader->get_next_question_id($questiondata->category,
224                         (bool) $questiondata->questiontext);
225             if ($questionid === null) {
226                 throw new moodle_exception('notenoughrandomquestions', 'quiz',
227                                            $quizobj->view_url(), $questiondata);
228             }
230             $questions[$slot] = question_bank::load_question($questionid,
231                     $quizobj->get_quiz()->shuffleanswers);
232         }
233     }
235     // Finally add them all to the usage.
236     ksort($questions);
237     foreach ($questions as $slot => $question) {
238         $newslot = $quba->add_question($question, $maxmark[$slot]);
239         if ($newslot != $slot) {
240             throw new coding_exception('Slot numbers have got confused.');
241         }
242     }
244     // Start all the questions.
245     $variantstrategy = new core_question\engine\variants\least_used_strategy($quba, $qubaids);
247     if (!empty($forcedvariantsbyslot)) {
248         $forcedvariantsbyseed = question_variant_forced_choices_selection_strategy::prepare_forced_choices_array(
249             $forcedvariantsbyslot, $quba);
250         $variantstrategy = new question_variant_forced_choices_selection_strategy(
251             $forcedvariantsbyseed, $variantstrategy);
252     }
254     $quba->start_all_questions($variantstrategy, $timenow);
256     // Work out the attempt layout.
257     $sections = $quizobj->get_sections();
258     foreach ($sections as $i => $section) {
259         if (isset($sections[$i + 1])) {
260             $sections[$i]->lastslot = $sections[$i + 1]->firstslot - 1;
261         } else {
262             $sections[$i]->lastslot = count($questions);
263         }
264     }
266     $layout = array();
267     foreach ($sections as $section) {
268         if ($section->shufflequestions) {
269             $questionsinthissection = array();
270             for ($slot = $section->firstslot; $slot <= $section->lastslot; $slot += 1) {
271                 $questionsinthissection[] = $slot;
272             }
273             shuffle($questionsinthissection);
274             $questionsonthispage = 0;
275             foreach ($questionsinthissection as $slot) {
276                 if ($questionsonthispage && $questionsonthispage == $quizobj->get_quiz()->questionsperpage) {
277                     $layout[] = 0;
278                     $questionsonthispage = 0;
279                 }
280                 $layout[] = $slot;
281                 $questionsonthispage += 1;
282             }
284         } else {
285             $currentpage = $page[$section->firstslot];
286             for ($slot = $section->firstslot; $slot <= $section->lastslot; $slot += 1) {
287                 if ($currentpage !== null && $page[$slot] != $currentpage) {
288                     $layout[] = 0;
289                 }
290                 $layout[] = $slot;
291                 $currentpage = $page[$slot];
292             }
293         }
295         // Each section ends with a page break.
296         $layout[] = 0;
297     }
298     $attempt->layout = implode(',', $layout);
300     return $attempt;
303 /**
304  * Start a subsequent new attempt, in each attempt builds on last mode.
305  *
306  * @param question_usage_by_activity    $quba         this question usage
307  * @param object                        $attempt      this attempt
308  * @param object                        $lastattempt  last attempt
309  * @return object                       modified attempt object
310  *
311  */
312 function quiz_start_attempt_built_on_last($quba, $attempt, $lastattempt) {
313     $oldquba = question_engine::load_questions_usage_by_activity($lastattempt->uniqueid);
315     $oldnumberstonew = array();
316     foreach ($oldquba->get_attempt_iterator() as $oldslot => $oldqa) {
317         $newslot = $quba->add_question($oldqa->get_question(), $oldqa->get_max_mark());
319         $quba->start_question_based_on($newslot, $oldqa);
321         $oldnumberstonew[$oldslot] = $newslot;
322     }
324     // Update attempt layout.
325     $newlayout = array();
326     foreach (explode(',', $lastattempt->layout) as $oldslot) {
327         if ($oldslot != 0) {
328             $newlayout[] = $oldnumberstonew[$oldslot];
329         } else {
330             $newlayout[] = 0;
331         }
332     }
333     $attempt->layout = implode(',', $newlayout);
334     return $attempt;
337 /**
338  * The save started question usage and quiz attempt in db and log the started attempt.
339  *
340  * @param quiz                       $quizobj
341  * @param question_usage_by_activity $quba
342  * @param object                     $attempt
343  * @return object                    attempt object with uniqueid and id set.
344  */
345 function quiz_attempt_save_started($quizobj, $quba, $attempt) {
346     global $DB;
347     // Save the attempt in the database.
348     question_engine::save_questions_usage_by_activity($quba);
349     $attempt->uniqueid = $quba->get_id();
350     $attempt->id = $DB->insert_record('quiz_attempts', $attempt);
352     // Params used by the events below.
353     $params = array(
354         'objectid' => $attempt->id,
355         'relateduserid' => $attempt->userid,
356         'courseid' => $quizobj->get_courseid(),
357         'context' => $quizobj->get_context()
358     );
359     // Decide which event we are using.
360     if ($attempt->preview) {
361         $params['other'] = array(
362             'quizid' => $quizobj->get_quizid()
363         );
364         $event = \mod_quiz\event\attempt_preview_started::create($params);
365     } else {
366         $event = \mod_quiz\event\attempt_started::create($params);
368     }
370     // Trigger the event.
371     $event->add_record_snapshot('quiz', $quizobj->get_quiz());
372     $event->add_record_snapshot('quiz_attempts', $attempt);
373     $event->trigger();
375     return $attempt;
378 /**
379  * Returns an unfinished attempt (if there is one) for the given
380  * user on the given quiz. This function does not return preview attempts.
381  *
382  * @param int $quizid the id of the quiz.
383  * @param int $userid the id of the user.
384  *
385  * @return mixed the unfinished attempt if there is one, false if not.
386  */
387 function quiz_get_user_attempt_unfinished($quizid, $userid) {
388     $attempts = quiz_get_user_attempts($quizid, $userid, 'unfinished', true);
389     if ($attempts) {
390         return array_shift($attempts);
391     } else {
392         return false;
393     }
396 /**
397  * Delete a quiz attempt.
398  * @param mixed $attempt an integer attempt id or an attempt object
399  *      (row of the quiz_attempts table).
400  * @param object $quiz the quiz object.
401  */
402 function quiz_delete_attempt($attempt, $quiz) {
403     global $DB;
404     if (is_numeric($attempt)) {
405         if (!$attempt = $DB->get_record('quiz_attempts', array('id' => $attempt))) {
406             return;
407         }
408     }
410     if ($attempt->quiz != $quiz->id) {
411         debugging("Trying to delete attempt $attempt->id which belongs to quiz $attempt->quiz " .
412                 "but was passed quiz $quiz->id.");
413         return;
414     }
416     if (!isset($quiz->cmid)) {
417         $cm = get_coursemodule_from_instance('quiz', $quiz->id, $quiz->course);
418         $quiz->cmid = $cm->id;
419     }
421     question_engine::delete_questions_usage_by_activity($attempt->uniqueid);
422     $DB->delete_records('quiz_attempts', array('id' => $attempt->id));
424     // Log the deletion of the attempt if not a preview.
425     if (!$attempt->preview) {
426         $params = array(
427             'objectid' => $attempt->id,
428             'relateduserid' => $attempt->userid,
429             'context' => context_module::instance($quiz->cmid),
430             'other' => array(
431                 'quizid' => $quiz->id
432             )
433         );
434         $event = \mod_quiz\event\attempt_deleted::create($params);
435         $event->add_record_snapshot('quiz_attempts', $attempt);
436         $event->trigger();
437     }
439     // Search quiz_attempts for other instances by this user.
440     // If none, then delete record for this quiz, this user from quiz_grades
441     // else recalculate best grade.
442     $userid = $attempt->userid;
443     if (!$DB->record_exists('quiz_attempts', array('userid' => $userid, 'quiz' => $quiz->id))) {
444         $DB->delete_records('quiz_grades', array('userid' => $userid, 'quiz' => $quiz->id));
445     } else {
446         quiz_save_best_grade($quiz, $userid);
447     }
449     quiz_update_grades($quiz, $userid);
452 /**
453  * Delete all the preview attempts at a quiz, or possibly all the attempts belonging
454  * to one user.
455  * @param object $quiz the quiz object.
456  * @param int $userid (optional) if given, only delete the previews belonging to this user.
457  */
458 function quiz_delete_previews($quiz, $userid = null) {
459     global $DB;
460     $conditions = array('quiz' => $quiz->id, 'preview' => 1);
461     if (!empty($userid)) {
462         $conditions['userid'] = $userid;
463     }
464     $previewattempts = $DB->get_records('quiz_attempts', $conditions);
465     foreach ($previewattempts as $attempt) {
466         quiz_delete_attempt($attempt, $quiz);
467     }
470 /**
471  * @param int $quizid The quiz id.
472  * @return bool whether this quiz has any (non-preview) attempts.
473  */
474 function quiz_has_attempts($quizid) {
475     global $DB;
476     return $DB->record_exists('quiz_attempts', array('quiz' => $quizid, 'preview' => 0));
479 // Functions to do with quiz layout and pages //////////////////////////////////
481 /**
482  * Repaginate the questions in a quiz
483  * @param int $quizid the id of the quiz to repaginate.
484  * @param int $slotsperpage number of items to put on each page. 0 means unlimited.
485  */
486 function quiz_repaginate_questions($quizid, $slotsperpage) {
487     global $DB;
488     $trans = $DB->start_delegated_transaction();
490     $sections = $DB->get_records('quiz_sections', array('quizid' => $quizid), 'firstslot ASC');
491     $firstslots = array();
492     foreach ($sections as $section) {
493         if ((int)$section->firstslot === 1) {
494             continue;
495         }
496         $firstslots[] = $section->firstslot;
497     }
499     $slots = $DB->get_records('quiz_slots', array('quizid' => $quizid),
500             'slot');
501     $currentpage = 1;
502     $slotsonthispage = 0;
503     foreach ($slots as $slot) {
504         if (($firstslots && in_array($slot->slot, $firstslots)) ||
505             ($slotsonthispage && $slotsonthispage == $slotsperpage)) {
506             $currentpage += 1;
507             $slotsonthispage = 0;
508         }
509         if ($slot->page != $currentpage) {
510             $DB->set_field('quiz_slots', 'page', $currentpage, array('id' => $slot->id));
511         }
512         $slotsonthispage += 1;
513     }
515     $trans->allow_commit();
518 // Functions to do with quiz grades ////////////////////////////////////////////
520 /**
521  * Convert the raw grade stored in $attempt into a grade out of the maximum
522  * grade for this quiz.
523  *
524  * @param float $rawgrade the unadjusted grade, fof example $attempt->sumgrades
525  * @param object $quiz the quiz object. Only the fields grade, sumgrades and decimalpoints are used.
526  * @param bool|string $format whether to format the results for display
527  *      or 'question' to format a question grade (different number of decimal places.
528  * @return float|string the rescaled grade, or null/the lang string 'notyetgraded'
529  *      if the $grade is null.
530  */
531 function quiz_rescale_grade($rawgrade, $quiz, $format = true) {
532     if (is_null($rawgrade)) {
533         $grade = null;
534     } else if ($quiz->sumgrades >= 0.000005) {
535         $grade = $rawgrade * $quiz->grade / $quiz->sumgrades;
536     } else {
537         $grade = 0;
538     }
539     if ($format === 'question') {
540         $grade = quiz_format_question_grade($quiz, $grade);
541     } else if ($format) {
542         $grade = quiz_format_grade($quiz, $grade);
543     }
544     return $grade;
547 /**
548  * Get the feedback text that should be show to a student who
549  * got this grade on this quiz. The feedback is processed ready for diplay.
550  *
551  * @param float $grade a grade on this quiz.
552  * @param object $quiz the quiz settings.
553  * @param object $context the quiz context.
554  * @return string the comment that corresponds to this grade (empty string if there is not one.
555  */
556 function quiz_feedback_for_grade($grade, $quiz, $context) {
557     global $DB;
559     if (is_null($grade)) {
560         return '';
561     }
563     // With CBM etc, it is possible to get -ve grades, which would then not match
564     // any feedback. Therefore, we replace -ve grades with 0.
565     $grade = max($grade, 0);
567     $feedback = $DB->get_record_select('quiz_feedback',
568             'quizid = ? AND mingrade <= ? AND ? < maxgrade', array($quiz->id, $grade, $grade));
570     if (empty($feedback->feedbacktext)) {
571         return '';
572     }
574     // Clean the text, ready for display.
575     $formatoptions = new stdClass();
576     $formatoptions->noclean = true;
577     $feedbacktext = file_rewrite_pluginfile_urls($feedback->feedbacktext, 'pluginfile.php',
578             $context->id, 'mod_quiz', 'feedback', $feedback->id);
579     $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
581     return $feedbacktext;
584 /**
585  * @param object $quiz the quiz database row.
586  * @return bool Whether this quiz has any non-blank feedback text.
587  */
588 function quiz_has_feedback($quiz) {
589     global $DB;
590     static $cache = array();
591     if (!array_key_exists($quiz->id, $cache)) {
592         $cache[$quiz->id] = quiz_has_grades($quiz) &&
593                 $DB->record_exists_select('quiz_feedback', "quizid = ? AND " .
594                     $DB->sql_isnotempty('quiz_feedback', 'feedbacktext', false, true),
595                 array($quiz->id));
596     }
597     return $cache[$quiz->id];
600 /**
601  * Update the sumgrades field of the quiz. This needs to be called whenever
602  * the grading structure of the quiz is changed. For example if a question is
603  * added or removed, or a question weight is changed.
604  *
605  * You should call {@link quiz_delete_previews()} before you call this function.
606  *
607  * @param object $quiz a quiz.
608  */
609 function quiz_update_sumgrades($quiz) {
610     global $DB;
612     $sql = 'UPDATE {quiz}
613             SET sumgrades = COALESCE((
614                 SELECT SUM(maxmark)
615                 FROM {quiz_slots}
616                 WHERE quizid = {quiz}.id
617             ), 0)
618             WHERE id = ?';
619     $DB->execute($sql, array($quiz->id));
620     $quiz->sumgrades = $DB->get_field('quiz', 'sumgrades', array('id' => $quiz->id));
622     if ($quiz->sumgrades < 0.000005 && quiz_has_attempts($quiz->id)) {
623         // If the quiz has been attempted, and the sumgrades has been
624         // set to 0, then we must also set the maximum possible grade to 0, or
625         // we will get a divide by zero error.
626         quiz_set_grade(0, $quiz);
627     }
630 /**
631  * Update the sumgrades field of the attempts at a quiz.
632  *
633  * @param object $quiz a quiz.
634  */
635 function quiz_update_all_attempt_sumgrades($quiz) {
636     global $DB;
637     $dm = new question_engine_data_mapper();
638     $timenow = time();
640     $sql = "UPDATE {quiz_attempts}
641             SET
642                 timemodified = :timenow,
643                 sumgrades = (
644                     {$dm->sum_usage_marks_subquery('uniqueid')}
645                 )
646             WHERE quiz = :quizid AND state = :finishedstate";
647     $DB->execute($sql, array('timenow' => $timenow, 'quizid' => $quiz->id,
648             'finishedstate' => quiz_attempt::FINISHED));
651 /**
652  * The quiz grade is the maximum that student's results are marked out of. When it
653  * changes, the corresponding data in quiz_grades and quiz_feedback needs to be
654  * rescaled. After calling this function, you probably need to call
655  * quiz_update_all_attempt_sumgrades, quiz_update_all_final_grades and
656  * quiz_update_grades.
657  *
658  * @param float $newgrade the new maximum grade for the quiz.
659  * @param object $quiz the quiz we are updating. Passed by reference so its
660  *      grade field can be updated too.
661  * @return bool indicating success or failure.
662  */
663 function quiz_set_grade($newgrade, $quiz) {
664     global $DB;
665     // This is potentially expensive, so only do it if necessary.
666     if (abs($quiz->grade - $newgrade) < 1e-7) {
667         // Nothing to do.
668         return true;
669     }
671     $oldgrade = $quiz->grade;
672     $quiz->grade = $newgrade;
674     // Use a transaction, so that on those databases that support it, this is safer.
675     $transaction = $DB->start_delegated_transaction();
677     // Update the quiz table.
678     $DB->set_field('quiz', 'grade', $newgrade, array('id' => $quiz->instance));
680     if ($oldgrade < 1) {
681         // If the old grade was zero, we cannot rescale, we have to recompute.
682         // We also recompute if the old grade was too small to avoid underflow problems.
683         quiz_update_all_final_grades($quiz);
685     } else {
686         // We can rescale the grades efficiently.
687         $timemodified = time();
688         $DB->execute("
689                 UPDATE {quiz_grades}
690                 SET grade = ? * grade, timemodified = ?
691                 WHERE quiz = ?
692         ", array($newgrade/$oldgrade, $timemodified, $quiz->id));
693     }
695     if ($oldgrade > 1e-7) {
696         // Update the quiz_feedback table.
697         $factor = $newgrade/$oldgrade;
698         $DB->execute("
699                 UPDATE {quiz_feedback}
700                 SET mingrade = ? * mingrade, maxgrade = ? * maxgrade
701                 WHERE quizid = ?
702         ", array($factor, $factor, $quiz->id));
703     }
705     // Update grade item and send all grades to gradebook.
706     quiz_grade_item_update($quiz);
707     quiz_update_grades($quiz);
709     $transaction->allow_commit();
710     return true;
713 /**
714  * Save the overall grade for a user at a quiz in the quiz_grades table
715  *
716  * @param object $quiz The quiz for which the best grade is to be calculated and then saved.
717  * @param int $userid The userid to calculate the grade for. Defaults to the current user.
718  * @param array $attempts The attempts of this user. Useful if you are
719  * looping through many users. Attempts can be fetched in one master query to
720  * avoid repeated querying.
721  * @return bool Indicates success or failure.
722  */
723 function quiz_save_best_grade($quiz, $userid = null, $attempts = array()) {
724     global $DB, $OUTPUT, $USER;
726     if (empty($userid)) {
727         $userid = $USER->id;
728     }
730     if (!$attempts) {
731         // Get all the attempts made by the user.
732         $attempts = quiz_get_user_attempts($quiz->id, $userid);
733     }
735     // Calculate the best grade.
736     $bestgrade = quiz_calculate_best_grade($quiz, $attempts);
737     $bestgrade = quiz_rescale_grade($bestgrade, $quiz, false);
739     // Save the best grade in the database.
740     if (is_null($bestgrade)) {
741         $DB->delete_records('quiz_grades', array('quiz' => $quiz->id, 'userid' => $userid));
743     } else if ($grade = $DB->get_record('quiz_grades',
744             array('quiz' => $quiz->id, 'userid' => $userid))) {
745         $grade->grade = $bestgrade;
746         $grade->timemodified = time();
747         $DB->update_record('quiz_grades', $grade);
749     } else {
750         $grade = new stdClass();
751         $grade->quiz = $quiz->id;
752         $grade->userid = $userid;
753         $grade->grade = $bestgrade;
754         $grade->timemodified = time();
755         $DB->insert_record('quiz_grades', $grade);
756     }
758     quiz_update_grades($quiz, $userid);
761 /**
762  * Calculate the overall grade for a quiz given a number of attempts by a particular user.
763  *
764  * @param object $quiz    the quiz settings object.
765  * @param array $attempts an array of all the user's attempts at this quiz in order.
766  * @return float          the overall grade
767  */
768 function quiz_calculate_best_grade($quiz, $attempts) {
770     switch ($quiz->grademethod) {
772         case QUIZ_ATTEMPTFIRST:
773             $firstattempt = reset($attempts);
774             return $firstattempt->sumgrades;
776         case QUIZ_ATTEMPTLAST:
777             $lastattempt = end($attempts);
778             return $lastattempt->sumgrades;
780         case QUIZ_GRADEAVERAGE:
781             $sum = 0;
782             $count = 0;
783             foreach ($attempts as $attempt) {
784                 if (!is_null($attempt->sumgrades)) {
785                     $sum += $attempt->sumgrades;
786                     $count++;
787                 }
788             }
789             if ($count == 0) {
790                 return null;
791             }
792             return $sum / $count;
794         case QUIZ_GRADEHIGHEST:
795         default:
796             $max = null;
797             foreach ($attempts as $attempt) {
798                 if ($attempt->sumgrades > $max) {
799                     $max = $attempt->sumgrades;
800                 }
801             }
802             return $max;
803     }
806 /**
807  * Update the final grade at this quiz for all students.
808  *
809  * This function is equivalent to calling quiz_save_best_grade for all
810  * users, but much more efficient.
811  *
812  * @param object $quiz the quiz settings.
813  */
814 function quiz_update_all_final_grades($quiz) {
815     global $DB;
817     if (!$quiz->sumgrades) {
818         return;
819     }
821     $param = array('iquizid' => $quiz->id, 'istatefinished' => quiz_attempt::FINISHED);
822     $firstlastattemptjoin = "JOIN (
823             SELECT
824                 iquiza.userid,
825                 MIN(attempt) AS firstattempt,
826                 MAX(attempt) AS lastattempt
828             FROM {quiz_attempts} iquiza
830             WHERE
831                 iquiza.state = :istatefinished AND
832                 iquiza.preview = 0 AND
833                 iquiza.quiz = :iquizid
835             GROUP BY iquiza.userid
836         ) first_last_attempts ON first_last_attempts.userid = quiza.userid";
838     switch ($quiz->grademethod) {
839         case QUIZ_ATTEMPTFIRST:
840             // Because of the where clause, there will only be one row, but we
841             // must still use an aggregate function.
842             $select = 'MAX(quiza.sumgrades)';
843             $join = $firstlastattemptjoin;
844             $where = 'quiza.attempt = first_last_attempts.firstattempt AND';
845             break;
847         case QUIZ_ATTEMPTLAST:
848             // Because of the where clause, there will only be one row, but we
849             // must still use an aggregate function.
850             $select = 'MAX(quiza.sumgrades)';
851             $join = $firstlastattemptjoin;
852             $where = 'quiza.attempt = first_last_attempts.lastattempt AND';
853             break;
855         case QUIZ_GRADEAVERAGE:
856             $select = 'AVG(quiza.sumgrades)';
857             $join = '';
858             $where = '';
859             break;
861         default:
862         case QUIZ_GRADEHIGHEST:
863             $select = 'MAX(quiza.sumgrades)';
864             $join = '';
865             $where = '';
866             break;
867     }
869     if ($quiz->sumgrades >= 0.000005) {
870         $finalgrade = $select . ' * ' . ($quiz->grade / $quiz->sumgrades);
871     } else {
872         $finalgrade = '0';
873     }
874     $param['quizid'] = $quiz->id;
875     $param['quizid2'] = $quiz->id;
876     $param['quizid3'] = $quiz->id;
877     $param['quizid4'] = $quiz->id;
878     $param['statefinished'] = quiz_attempt::FINISHED;
879     $param['statefinished2'] = quiz_attempt::FINISHED;
880     $finalgradesubquery = "
881             SELECT quiza.userid, $finalgrade AS newgrade
882             FROM {quiz_attempts} quiza
883             $join
884             WHERE
885                 $where
886                 quiza.state = :statefinished AND
887                 quiza.preview = 0 AND
888                 quiza.quiz = :quizid3
889             GROUP BY quiza.userid";
891     $changedgrades = $DB->get_records_sql("
892             SELECT users.userid, qg.id, qg.grade, newgrades.newgrade
894             FROM (
895                 SELECT userid
896                 FROM {quiz_grades} qg
897                 WHERE quiz = :quizid
898             UNION
899                 SELECT DISTINCT userid
900                 FROM {quiz_attempts} quiza2
901                 WHERE
902                     quiza2.state = :statefinished2 AND
903                     quiza2.preview = 0 AND
904                     quiza2.quiz = :quizid2
905             ) users
907             LEFT JOIN {quiz_grades} qg ON qg.userid = users.userid AND qg.quiz = :quizid4
909             LEFT JOIN (
910                 $finalgradesubquery
911             ) newgrades ON newgrades.userid = users.userid
913             WHERE
914                 ABS(newgrades.newgrade - qg.grade) > 0.000005 OR
915                 ((newgrades.newgrade IS NULL OR qg.grade IS NULL) AND NOT
916                           (newgrades.newgrade IS NULL AND qg.grade IS NULL))",
917                 // The mess on the previous line is detecting where the value is
918                 // NULL in one column, and NOT NULL in the other, but SQL does
919                 // not have an XOR operator, and MS SQL server can't cope with
920                 // (newgrades.newgrade IS NULL) <> (qg.grade IS NULL).
921             $param);
923     $timenow = time();
924     $todelete = array();
925     foreach ($changedgrades as $changedgrade) {
927         if (is_null($changedgrade->newgrade)) {
928             $todelete[] = $changedgrade->userid;
930         } else if (is_null($changedgrade->grade)) {
931             $toinsert = new stdClass();
932             $toinsert->quiz = $quiz->id;
933             $toinsert->userid = $changedgrade->userid;
934             $toinsert->timemodified = $timenow;
935             $toinsert->grade = $changedgrade->newgrade;
936             $DB->insert_record('quiz_grades', $toinsert);
938         } else {
939             $toupdate = new stdClass();
940             $toupdate->id = $changedgrade->id;
941             $toupdate->grade = $changedgrade->newgrade;
942             $toupdate->timemodified = $timenow;
943             $DB->update_record('quiz_grades', $toupdate);
944         }
945     }
947     if (!empty($todelete)) {
948         list($test, $params) = $DB->get_in_or_equal($todelete);
949         $DB->delete_records_select('quiz_grades', 'quiz = ? AND userid ' . $test,
950                 array_merge(array($quiz->id), $params));
951     }
954 /**
955  * Efficiently update check state time on all open attempts
956  *
957  * @param array $conditions optional restrictions on which attempts to update
958  *                    Allowed conditions:
959  *                      courseid => (array|int) attempts in given course(s)
960  *                      userid   => (array|int) attempts for given user(s)
961  *                      quizid   => (array|int) attempts in given quiz(s)
962  *                      groupid  => (array|int) quizzes with some override for given group(s)
963  *
964  */
965 function quiz_update_open_attempts(array $conditions) {
966     global $DB;
968     foreach ($conditions as &$value) {
969         if (!is_array($value)) {
970             $value = array($value);
971         }
972     }
974     $params = array();
975     $wheres = array("quiza.state IN ('inprogress', 'overdue')");
976     $iwheres = array("iquiza.state IN ('inprogress', 'overdue')");
978     if (isset($conditions['courseid'])) {
979         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['courseid'], SQL_PARAMS_NAMED, 'cid');
980         $params = array_merge($params, $inparams);
981         $wheres[] = "quiza.quiz IN (SELECT q.id FROM {quiz} q WHERE q.course $incond)";
982         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['courseid'], SQL_PARAMS_NAMED, 'icid');
983         $params = array_merge($params, $inparams);
984         $iwheres[] = "iquiza.quiz IN (SELECT q.id FROM {quiz} q WHERE q.course $incond)";
985     }
987     if (isset($conditions['userid'])) {
988         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['userid'], SQL_PARAMS_NAMED, 'uid');
989         $params = array_merge($params, $inparams);
990         $wheres[] = "quiza.userid $incond";
991         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['userid'], SQL_PARAMS_NAMED, 'iuid');
992         $params = array_merge($params, $inparams);
993         $iwheres[] = "iquiza.userid $incond";
994     }
996     if (isset($conditions['quizid'])) {
997         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['quizid'], SQL_PARAMS_NAMED, 'qid');
998         $params = array_merge($params, $inparams);
999         $wheres[] = "quiza.quiz $incond";
1000         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['quizid'], SQL_PARAMS_NAMED, 'iqid');
1001         $params = array_merge($params, $inparams);
1002         $iwheres[] = "iquiza.quiz $incond";
1003     }
1005     if (isset($conditions['groupid'])) {
1006         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['groupid'], SQL_PARAMS_NAMED, 'gid');
1007         $params = array_merge($params, $inparams);
1008         $wheres[] = "quiza.quiz IN (SELECT qo.quiz FROM {quiz_overrides} qo WHERE qo.groupid $incond)";
1009         list ($incond, $inparams) = $DB->get_in_or_equal($conditions['groupid'], SQL_PARAMS_NAMED, 'igid');
1010         $params = array_merge($params, $inparams);
1011         $iwheres[] = "iquiza.quiz IN (SELECT qo.quiz FROM {quiz_overrides} qo WHERE qo.groupid $incond)";
1012     }
1014     // SQL to compute timeclose and timelimit for each attempt:
1015     $quizausersql = quiz_get_attempt_usertime_sql(
1016             implode("\n                AND ", $iwheres));
1018     // SQL to compute the new timecheckstate
1019     $timecheckstatesql = "
1020           CASE WHEN quizauser.usertimelimit = 0 AND quizauser.usertimeclose = 0 THEN NULL
1021                WHEN quizauser.usertimelimit = 0 THEN quizauser.usertimeclose
1022                WHEN quizauser.usertimeclose = 0 THEN quiza.timestart + quizauser.usertimelimit
1023                WHEN quiza.timestart + quizauser.usertimelimit < quizauser.usertimeclose THEN quiza.timestart + quizauser.usertimelimit
1024                ELSE quizauser.usertimeclose END +
1025           CASE WHEN quiza.state = 'overdue' THEN quiz.graceperiod ELSE 0 END";
1027     // SQL to select which attempts to process
1028     $attemptselect = implode("\n                         AND ", $wheres);
1030    /*
1031     * Each database handles updates with inner joins differently:
1032     *  - mysql does not allow a FROM clause
1033     *  - postgres and mssql allow FROM but handle table aliases differently
1034     *  - oracle requires a subquery
1035     *
1036     * Different code for each database.
1037     */
1039     $dbfamily = $DB->get_dbfamily();
1040     if ($dbfamily == 'mysql') {
1041         $updatesql = "UPDATE {quiz_attempts} quiza
1042                         JOIN {quiz} quiz ON quiz.id = quiza.quiz
1043                         JOIN ( $quizausersql ) quizauser ON quizauser.id = quiza.id
1044                          SET quiza.timecheckstate = $timecheckstatesql
1045                        WHERE $attemptselect";
1046     } else if ($dbfamily == 'postgres') {
1047         $updatesql = "UPDATE {quiz_attempts} quiza
1048                          SET timecheckstate = $timecheckstatesql
1049                         FROM {quiz} quiz, ( $quizausersql ) quizauser
1050                        WHERE quiz.id = quiza.quiz
1051                          AND quizauser.id = quiza.id
1052                          AND $attemptselect";
1053     } else if ($dbfamily == 'mssql') {
1054         $updatesql = "UPDATE quiza
1055                          SET timecheckstate = $timecheckstatesql
1056                         FROM {quiz_attempts} quiza
1057                         JOIN {quiz} quiz ON quiz.id = quiza.quiz
1058                         JOIN ( $quizausersql ) quizauser ON quizauser.id = quiza.id
1059                        WHERE $attemptselect";
1060     } else {
1061         // oracle, sqlite and others
1062         $updatesql = "UPDATE {quiz_attempts} quiza
1063                          SET timecheckstate = (
1064                            SELECT $timecheckstatesql
1065                              FROM {quiz} quiz, ( $quizausersql ) quizauser
1066                             WHERE quiz.id = quiza.quiz
1067                               AND quizauser.id = quiza.id
1068                          )
1069                          WHERE $attemptselect";
1070     }
1072     $DB->execute($updatesql, $params);
1075 /**
1076  * Returns SQL to compute timeclose and timelimit for every attempt, taking into account user and group overrides.
1077  *
1078  * @param string $redundantwhereclauses extra where clauses to add to the subquery
1079  *      for performance. These can use the table alias iquiza for the quiz attempts table.
1080  * @return string SQL select with columns attempt.id, usertimeclose, usertimelimit.
1081  */
1082 function quiz_get_attempt_usertime_sql($redundantwhereclauses = '') {
1083     if ($redundantwhereclauses) {
1084         $redundantwhereclauses = 'WHERE ' . $redundantwhereclauses;
1085     }
1086     // The multiple qgo JOINS are necessary because we want timeclose/timelimit = 0 (unlimited) to supercede
1087     // any other group override
1088     $quizausersql = "
1089           SELECT iquiza.id,
1090            COALESCE(MAX(quo.timeclose), MAX(qgo1.timeclose), MAX(qgo2.timeclose), iquiz.timeclose) AS usertimeclose,
1091            COALESCE(MAX(quo.timelimit), MAX(qgo3.timelimit), MAX(qgo4.timelimit), iquiz.timelimit) AS usertimelimit
1093            FROM {quiz_attempts} iquiza
1094            JOIN {quiz} iquiz ON iquiz.id = iquiza.quiz
1095       LEFT JOIN {quiz_overrides} quo ON quo.quiz = iquiza.quiz AND quo.userid = iquiza.userid
1096       LEFT JOIN {groups_members} gm ON gm.userid = iquiza.userid
1097       LEFT JOIN {quiz_overrides} qgo1 ON qgo1.quiz = iquiza.quiz AND qgo1.groupid = gm.groupid AND qgo1.timeclose = 0
1098       LEFT JOIN {quiz_overrides} qgo2 ON qgo2.quiz = iquiza.quiz AND qgo2.groupid = gm.groupid AND qgo2.timeclose > 0
1099       LEFT JOIN {quiz_overrides} qgo3 ON qgo3.quiz = iquiza.quiz AND qgo3.groupid = gm.groupid AND qgo3.timelimit = 0
1100       LEFT JOIN {quiz_overrides} qgo4 ON qgo4.quiz = iquiza.quiz AND qgo4.groupid = gm.groupid AND qgo4.timelimit > 0
1101           $redundantwhereclauses
1102        GROUP BY iquiza.id, iquiz.id, iquiz.timeclose, iquiz.timelimit";
1103     return $quizausersql;
1106 /**
1107  * Return the attempt with the best grade for a quiz
1108  *
1109  * Which attempt is the best depends on $quiz->grademethod. If the grade
1110  * method is GRADEAVERAGE then this function simply returns the last attempt.
1111  * @return object         The attempt with the best grade
1112  * @param object $quiz    The quiz for which the best grade is to be calculated
1113  * @param array $attempts An array of all the attempts of the user at the quiz
1114  */
1115 function quiz_calculate_best_attempt($quiz, $attempts) {
1117     switch ($quiz->grademethod) {
1119         case QUIZ_ATTEMPTFIRST:
1120             foreach ($attempts as $attempt) {
1121                 return $attempt;
1122             }
1123             break;
1125         case QUIZ_GRADEAVERAGE: // We need to do something with it.
1126         case QUIZ_ATTEMPTLAST:
1127             foreach ($attempts as $attempt) {
1128                 $final = $attempt;
1129             }
1130             return $final;
1132         default:
1133         case QUIZ_GRADEHIGHEST:
1134             $max = -1;
1135             foreach ($attempts as $attempt) {
1136                 if ($attempt->sumgrades > $max) {
1137                     $max = $attempt->sumgrades;
1138                     $maxattempt = $attempt;
1139                 }
1140             }
1141             return $maxattempt;
1142     }
1145 /**
1146  * @return array int => lang string the options for calculating the quiz grade
1147  *      from the individual attempt grades.
1148  */
1149 function quiz_get_grading_options() {
1150     return array(
1151         QUIZ_GRADEHIGHEST => get_string('gradehighest', 'quiz'),
1152         QUIZ_GRADEAVERAGE => get_string('gradeaverage', 'quiz'),
1153         QUIZ_ATTEMPTFIRST => get_string('attemptfirst', 'quiz'),
1154         QUIZ_ATTEMPTLAST  => get_string('attemptlast', 'quiz')
1155     );
1158 /**
1159  * @param int $option one of the values QUIZ_GRADEHIGHEST, QUIZ_GRADEAVERAGE,
1160  *      QUIZ_ATTEMPTFIRST or QUIZ_ATTEMPTLAST.
1161  * @return the lang string for that option.
1162  */
1163 function quiz_get_grading_option_name($option) {
1164     $strings = quiz_get_grading_options();
1165     return $strings[$option];
1168 /**
1169  * @return array string => lang string the options for handling overdue quiz
1170  *      attempts.
1171  */
1172 function quiz_get_overdue_handling_options() {
1173     return array(
1174         'autosubmit'  => get_string('overduehandlingautosubmit', 'quiz'),
1175         'graceperiod' => get_string('overduehandlinggraceperiod', 'quiz'),
1176         'autoabandon' => get_string('overduehandlingautoabandon', 'quiz'),
1177     );
1180 /**
1181  * Get the choices for what size user picture to show.
1182  * @return array string => lang string the options for whether to display the user's picture.
1183  */
1184 function quiz_get_user_image_options() {
1185     return array(
1186         QUIZ_SHOWIMAGE_NONE  => get_string('shownoimage', 'quiz'),
1187         QUIZ_SHOWIMAGE_SMALL => get_string('showsmallimage', 'quiz'),
1188         QUIZ_SHOWIMAGE_LARGE => get_string('showlargeimage', 'quiz'),
1189     );
1192 /**
1193  * Get the choices to offer for the 'Questions per page' option.
1194  * @return array int => string.
1195  */
1196 function quiz_questions_per_page_options() {
1197     $pageoptions = array();
1198     $pageoptions[0] = get_string('neverallononepage', 'quiz');
1199     $pageoptions[1] = get_string('everyquestion', 'quiz');
1200     for ($i = 2; $i <= QUIZ_MAX_QPP_OPTION; ++$i) {
1201         $pageoptions[$i] = get_string('everynquestions', 'quiz', $i);
1202     }
1203     return $pageoptions;
1206 /**
1207  * Get the human-readable name for a quiz attempt state.
1208  * @param string $state one of the state constants like {@link quiz_attempt::IN_PROGRESS}.
1209  * @return string The lang string to describe that state.
1210  */
1211 function quiz_attempt_state_name($state) {
1212     switch ($state) {
1213         case quiz_attempt::IN_PROGRESS:
1214             return get_string('stateinprogress', 'quiz');
1215         case quiz_attempt::OVERDUE:
1216             return get_string('stateoverdue', 'quiz');
1217         case quiz_attempt::FINISHED:
1218             return get_string('statefinished', 'quiz');
1219         case quiz_attempt::ABANDONED:
1220             return get_string('stateabandoned', 'quiz');
1221         default:
1222             throw new coding_exception('Unknown quiz attempt state.');
1223     }
1226 // Other quiz functions ////////////////////////////////////////////////////////
1228 /**
1229  * @param object $quiz the quiz.
1230  * @param int $cmid the course_module object for this quiz.
1231  * @param object $question the question.
1232  * @param string $returnurl url to return to after action is done.
1233  * @param int $variant which question variant to preview (optional).
1234  * @return string html for a number of icons linked to action pages for a
1235  * question - preview and edit / view icons depending on user capabilities.
1236  */
1237 function quiz_question_action_icons($quiz, $cmid, $question, $returnurl, $variant = null) {
1238     $html = quiz_question_preview_button($quiz, $question, false, $variant) . ' ' .
1239             quiz_question_edit_button($cmid, $question, $returnurl);
1240     return $html;
1243 /**
1244  * @param int $cmid the course_module.id for this quiz.
1245  * @param object $question the question.
1246  * @param string $returnurl url to return to after action is done.
1247  * @param string $contentbeforeicon some HTML content to be added inside the link, before the icon.
1248  * @return the HTML for an edit icon, view icon, or nothing for a question
1249  *      (depending on permissions).
1250  */
1251 function quiz_question_edit_button($cmid, $question, $returnurl, $contentaftericon = '') {
1252     global $CFG, $OUTPUT;
1254     // Minor efficiency saving. Only get strings once, even if there are a lot of icons on one page.
1255     static $stredit = null;
1256     static $strview = null;
1257     if ($stredit === null) {
1258         $stredit = get_string('edit');
1259         $strview = get_string('view');
1260     }
1262     // What sort of icon should we show?
1263     $action = '';
1264     if (!empty($question->id) &&
1265             (question_has_capability_on($question, 'edit', $question->category) ||
1266                     question_has_capability_on($question, 'move', $question->category))) {
1267         $action = $stredit;
1268         $icon = '/t/edit';
1269     } else if (!empty($question->id) &&
1270             question_has_capability_on($question, 'view', $question->category)) {
1271         $action = $strview;
1272         $icon = '/i/info';
1273     }
1275     // Build the icon.
1276     if ($action) {
1277         if ($returnurl instanceof moodle_url) {
1278             $returnurl = $returnurl->out_as_local_url(false);
1279         }
1280         $questionparams = array('returnurl' => $returnurl, 'cmid' => $cmid, 'id' => $question->id);
1281         $questionurl = new moodle_url("$CFG->wwwroot/question/question.php", $questionparams);
1282         return '<a title="' . $action . '" href="' . $questionurl->out() . '" class="questioneditbutton"><img src="' .
1283                 $OUTPUT->pix_url($icon) . '" alt="' . $action . '" />' . $contentaftericon .
1284                 '</a>';
1285     } else if ($contentaftericon) {
1286         return '<span class="questioneditbutton">' . $contentaftericon . '</span>';
1287     } else {
1288         return '';
1289     }
1292 /**
1293  * @param object $quiz the quiz settings
1294  * @param object $question the question
1295  * @param int $variant which question variant to preview (optional).
1296  * @return moodle_url to preview this question with the options from this quiz.
1297  */
1298 function quiz_question_preview_url($quiz, $question, $variant = null) {
1299     // Get the appropriate display options.
1300     $displayoptions = mod_quiz_display_options::make_from_quiz($quiz,
1301             mod_quiz_display_options::DURING);
1303     $maxmark = null;
1304     if (isset($question->maxmark)) {
1305         $maxmark = $question->maxmark;
1306     }
1308     // Work out the correcte preview URL.
1309     return question_preview_url($question->id, $quiz->preferredbehaviour,
1310             $maxmark, $displayoptions, $variant);
1313 /**
1314  * @param object $quiz the quiz settings
1315  * @param object $question the question
1316  * @param bool $label if true, show the preview question label after the icon
1317  * @param int $variant which question variant to preview (optional).
1318  * @return the HTML for a preview question icon.
1319  */
1320 function quiz_question_preview_button($quiz, $question, $label = false, $variant = null) {
1321     global $PAGE;
1322     if (!question_has_capability_on($question, 'use', $question->category)) {
1323         return '';
1324     }
1326     return $PAGE->get_renderer('mod_quiz', 'edit')->question_preview_icon($quiz, $question, $label, $variant);
1329 /**
1330  * @param object $attempt the attempt.
1331  * @param object $context the quiz context.
1332  * @return int whether flags should be shown/editable to the current user for this attempt.
1333  */
1334 function quiz_get_flag_option($attempt, $context) {
1335     global $USER;
1336     if (!has_capability('moodle/question:flag', $context)) {
1337         return question_display_options::HIDDEN;
1338     } else if ($attempt->userid == $USER->id) {
1339         return question_display_options::EDITABLE;
1340     } else {
1341         return question_display_options::VISIBLE;
1342     }
1345 /**
1346  * Work out what state this quiz attempt is in - in the sense used by
1347  * quiz_get_review_options, not in the sense of $attempt->state.
1348  * @param object $quiz the quiz settings
1349  * @param object $attempt the quiz_attempt database row.
1350  * @return int one of the mod_quiz_display_options::DURING,
1351  *      IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
1352  */
1353 function quiz_attempt_state($quiz, $attempt) {
1354     if ($attempt->state == quiz_attempt::IN_PROGRESS) {
1355         return mod_quiz_display_options::DURING;
1356     } else if (time() < $attempt->timefinish + 120) {
1357         return mod_quiz_display_options::IMMEDIATELY_AFTER;
1358     } else if (!$quiz->timeclose || time() < $quiz->timeclose) {
1359         return mod_quiz_display_options::LATER_WHILE_OPEN;
1360     } else {
1361         return mod_quiz_display_options::AFTER_CLOSE;
1362     }
1365 /**
1366  * The the appropraite mod_quiz_display_options object for this attempt at this
1367  * quiz right now.
1368  *
1369  * @param object $quiz the quiz instance.
1370  * @param object $attempt the attempt in question.
1371  * @param $context the quiz context.
1372  *
1373  * @return mod_quiz_display_options
1374  */
1375 function quiz_get_review_options($quiz, $attempt, $context) {
1376     $options = mod_quiz_display_options::make_from_quiz($quiz, quiz_attempt_state($quiz, $attempt));
1378     $options->readonly = true;
1379     $options->flags = quiz_get_flag_option($attempt, $context);
1380     if (!empty($attempt->id)) {
1381         $options->questionreviewlink = new moodle_url('/mod/quiz/reviewquestion.php',
1382                 array('attempt' => $attempt->id));
1383     }
1385     // Show a link to the comment box only for closed attempts.
1386     if (!empty($attempt->id) && $attempt->state == quiz_attempt::FINISHED && !$attempt->preview &&
1387             !is_null($context) && has_capability('mod/quiz:grade', $context)) {
1388         $options->manualcomment = question_display_options::VISIBLE;
1389         $options->manualcommentlink = new moodle_url('/mod/quiz/comment.php',
1390                 array('attempt' => $attempt->id));
1391     }
1393     if (!is_null($context) && !$attempt->preview &&
1394             has_capability('mod/quiz:viewreports', $context) &&
1395             has_capability('moodle/grade:viewhidden', $context)) {
1396         // People who can see reports and hidden grades should be shown everything,
1397         // except during preview when teachers want to see what students see.
1398         $options->attempt = question_display_options::VISIBLE;
1399         $options->correctness = question_display_options::VISIBLE;
1400         $options->marks = question_display_options::MARK_AND_MAX;
1401         $options->feedback = question_display_options::VISIBLE;
1402         $options->numpartscorrect = question_display_options::VISIBLE;
1403         $options->manualcomment = question_display_options::VISIBLE;
1404         $options->generalfeedback = question_display_options::VISIBLE;
1405         $options->rightanswer = question_display_options::VISIBLE;
1406         $options->overallfeedback = question_display_options::VISIBLE;
1407         $options->history = question_display_options::VISIBLE;
1409     }
1411     return $options;
1414 /**
1415  * Combines the review options from a number of different quiz attempts.
1416  * Returns an array of two ojects, so the suggested way of calling this
1417  * funciton is:
1418  * list($someoptions, $alloptions) = quiz_get_combined_reviewoptions(...)
1419  *
1420  * @param object $quiz the quiz instance.
1421  * @param array $attempts an array of attempt objects.
1422  *
1423  * @return array of two options objects, one showing which options are true for
1424  *          at least one of the attempts, the other showing which options are true
1425  *          for all attempts.
1426  */
1427 function quiz_get_combined_reviewoptions($quiz, $attempts) {
1428     $fields = array('feedback', 'generalfeedback', 'rightanswer', 'overallfeedback');
1429     $someoptions = new stdClass();
1430     $alloptions = new stdClass();
1431     foreach ($fields as $field) {
1432         $someoptions->$field = false;
1433         $alloptions->$field = true;
1434     }
1435     $someoptions->marks = question_display_options::HIDDEN;
1436     $alloptions->marks = question_display_options::MARK_AND_MAX;
1438     // This shouldn't happen, but we need to prevent reveal information.
1439     if (empty($attempts)) {
1440         return array($someoptions, $someoptions);
1441     }
1443     foreach ($attempts as $attempt) {
1444         $attemptoptions = mod_quiz_display_options::make_from_quiz($quiz,
1445                 quiz_attempt_state($quiz, $attempt));
1446         foreach ($fields as $field) {
1447             $someoptions->$field = $someoptions->$field || $attemptoptions->$field;
1448             $alloptions->$field = $alloptions->$field && $attemptoptions->$field;
1449         }
1450         $someoptions->marks = max($someoptions->marks, $attemptoptions->marks);
1451         $alloptions->marks = min($alloptions->marks, $attemptoptions->marks);
1452     }
1453     return array($someoptions, $alloptions);
1456 // Functions for sending notification messages /////////////////////////////////
1458 /**
1459  * Sends a confirmation message to the student confirming that the attempt was processed.
1460  *
1461  * @param object $a lots of useful information that can be used in the message
1462  *      subject and body.
1463  *
1464  * @return int|false as for {@link message_send()}.
1465  */
1466 function quiz_send_confirmation($recipient, $a) {
1468     // Add information about the recipient to $a.
1469     // Don't do idnumber. we want idnumber to be the submitter's idnumber.
1470     $a->username     = fullname($recipient);
1471     $a->userusername = $recipient->username;
1473     // Prepare the message.
1474     $eventdata = new stdClass();
1475     $eventdata->component         = 'mod_quiz';
1476     $eventdata->name              = 'confirmation';
1477     $eventdata->notification      = 1;
1479     $eventdata->userfrom          = core_user::get_noreply_user();
1480     $eventdata->userto            = $recipient;
1481     $eventdata->subject           = get_string('emailconfirmsubject', 'quiz', $a);
1482     $eventdata->fullmessage       = get_string('emailconfirmbody', 'quiz', $a);
1483     $eventdata->fullmessageformat = FORMAT_PLAIN;
1484     $eventdata->fullmessagehtml   = '';
1486     $eventdata->smallmessage      = get_string('emailconfirmsmall', 'quiz', $a);
1487     $eventdata->contexturl        = $a->quizurl;
1488     $eventdata->contexturlname    = $a->quizname;
1490     // ... and send it.
1491     return message_send($eventdata);
1494 /**
1495  * Sends notification messages to the interested parties that assign the role capability
1496  *
1497  * @param object $recipient user object of the intended recipient
1498  * @param object $a associative array of replaceable fields for the templates
1499  *
1500  * @return int|false as for {@link message_send()}.
1501  */
1502 function quiz_send_notification($recipient, $submitter, $a) {
1504     // Recipient info for template.
1505     $a->useridnumber = $recipient->idnumber;
1506     $a->username     = fullname($recipient);
1507     $a->userusername = $recipient->username;
1509     // Prepare the message.
1510     $eventdata = new stdClass();
1511     $eventdata->component         = 'mod_quiz';
1512     $eventdata->name              = 'submission';
1513     $eventdata->notification      = 1;
1515     $eventdata->userfrom          = $submitter;
1516     $eventdata->userto            = $recipient;
1517     $eventdata->subject           = get_string('emailnotifysubject', 'quiz', $a);
1518     $eventdata->fullmessage       = get_string('emailnotifybody', 'quiz', $a);
1519     $eventdata->fullmessageformat = FORMAT_PLAIN;
1520     $eventdata->fullmessagehtml   = '';
1522     $eventdata->smallmessage      = get_string('emailnotifysmall', 'quiz', $a);
1523     $eventdata->contexturl        = $a->quizreviewurl;
1524     $eventdata->contexturlname    = $a->quizname;
1526     // ... and send it.
1527     return message_send($eventdata);
1530 /**
1531  * Send all the requried messages when a quiz attempt is submitted.
1532  *
1533  * @param object $course the course
1534  * @param object $quiz the quiz
1535  * @param object $attempt this attempt just finished
1536  * @param object $context the quiz context
1537  * @param object $cm the coursemodule for this quiz
1538  *
1539  * @return bool true if all necessary messages were sent successfully, else false.
1540  */
1541 function quiz_send_notification_messages($course, $quiz, $attempt, $context, $cm) {
1542     global $CFG, $DB;
1544     // Do nothing if required objects not present.
1545     if (empty($course) or empty($quiz) or empty($attempt) or empty($context)) {
1546         throw new coding_exception('$course, $quiz, $attempt, $context and $cm must all be set.');
1547     }
1549     $submitter = $DB->get_record('user', array('id' => $attempt->userid), '*', MUST_EXIST);
1551     // Check for confirmation required.
1552     $sendconfirm = false;
1553     $notifyexcludeusers = '';
1554     if (has_capability('mod/quiz:emailconfirmsubmission', $context, $submitter, false)) {
1555         $notifyexcludeusers = $submitter->id;
1556         $sendconfirm = true;
1557     }
1559     // Check for notifications required.
1560     $notifyfields = 'u.id, u.username, u.idnumber, u.email, u.emailstop, u.lang,
1561             u.timezone, u.mailformat, u.maildisplay, u.auth, u.suspended, u.deleted, ';
1562     $notifyfields .= get_all_user_name_fields(true, 'u');
1563     $groups = groups_get_all_groups($course->id, $submitter->id, $cm->groupingid);
1564     if (is_array($groups) && count($groups) > 0) {
1565         $groups = array_keys($groups);
1566     } else if (groups_get_activity_groupmode($cm, $course) != NOGROUPS) {
1567         // If the user is not in a group, and the quiz is set to group mode,
1568         // then set $groups to a non-existant id so that only users with
1569         // 'moodle/site:accessallgroups' get notified.
1570         $groups = -1;
1571     } else {
1572         $groups = '';
1573     }
1574     $userstonotify = get_users_by_capability($context, 'mod/quiz:emailnotifysubmission',
1575             $notifyfields, '', '', '', $groups, $notifyexcludeusers, false, false, true);
1577     if (empty($userstonotify) && !$sendconfirm) {
1578         return true; // Nothing to do.
1579     }
1581     $a = new stdClass();
1582     // Course info.
1583     $a->coursename      = $course->fullname;
1584     $a->courseshortname = $course->shortname;
1585     // Quiz info.
1586     $a->quizname        = $quiz->name;
1587     $a->quizreporturl   = $CFG->wwwroot . '/mod/quiz/report.php?id=' . $cm->id;
1588     $a->quizreportlink  = '<a href="' . $a->quizreporturl . '">' .
1589             format_string($quiz->name) . ' report</a>';
1590     $a->quizurl         = $CFG->wwwroot . '/mod/quiz/view.php?id=' . $cm->id;
1591     $a->quizlink        = '<a href="' . $a->quizurl . '">' . format_string($quiz->name) . '</a>';
1592     // Attempt info.
1593     $a->submissiontime  = userdate($attempt->timefinish);
1594     $a->timetaken       = format_time($attempt->timefinish - $attempt->timestart);
1595     $a->quizreviewurl   = $CFG->wwwroot . '/mod/quiz/review.php?attempt=' . $attempt->id;
1596     $a->quizreviewlink  = '<a href="' . $a->quizreviewurl . '">' .
1597             format_string($quiz->name) . ' review</a>';
1598     // Student who sat the quiz info.
1599     $a->studentidnumber = $submitter->idnumber;
1600     $a->studentname     = fullname($submitter);
1601     $a->studentusername = $submitter->username;
1603     $allok = true;
1605     // Send notifications if required.
1606     if (!empty($userstonotify)) {
1607         foreach ($userstonotify as $recipient) {
1608             $allok = $allok && quiz_send_notification($recipient, $submitter, $a);
1609         }
1610     }
1612     // Send confirmation if required. We send the student confirmation last, so
1613     // that if message sending is being intermittently buggy, which means we send
1614     // some but not all messages, and then try again later, then teachers may get
1615     // duplicate messages, but the student will always get exactly one.
1616     if ($sendconfirm) {
1617         $allok = $allok && quiz_send_confirmation($submitter, $a);
1618     }
1620     return $allok;
1623 /**
1624  * Send the notification message when a quiz attempt becomes overdue.
1625  *
1626  * @param quiz_attempt $attemptobj all the data about the quiz attempt.
1627  */
1628 function quiz_send_overdue_message($attemptobj) {
1629     global $CFG, $DB;
1631     $submitter = $DB->get_record('user', array('id' => $attemptobj->get_userid()), '*', MUST_EXIST);
1633     if (!$attemptobj->has_capability('mod/quiz:emailwarnoverdue', $submitter->id, false)) {
1634         return; // Message not required.
1635     }
1637     if (!$attemptobj->has_response_to_at_least_one_graded_question()) {
1638         return; // Message not required.
1639     }
1641     // Prepare lots of useful information that admins might want to include in
1642     // the email message.
1643     $quizname = format_string($attemptobj->get_quiz_name());
1645     $deadlines = array();
1646     if ($attemptobj->get_quiz()->timelimit) {
1647         $deadlines[] = $attemptobj->get_attempt()->timestart + $attemptobj->get_quiz()->timelimit;
1648     }
1649     if ($attemptobj->get_quiz()->timeclose) {
1650         $deadlines[] = $attemptobj->get_quiz()->timeclose;
1651     }
1652     $duedate = min($deadlines);
1653     $graceend = $duedate + $attemptobj->get_quiz()->graceperiod;
1655     $a = new stdClass();
1656     // Course info.
1657     $a->coursename         = format_string($attemptobj->get_course()->fullname);
1658     $a->courseshortname    = format_string($attemptobj->get_course()->shortname);
1659     // Quiz info.
1660     $a->quizname           = $quizname;
1661     $a->quizurl            = $attemptobj->view_url();
1662     $a->quizlink           = '<a href="' . $a->quizurl . '">' . $quizname . '</a>';
1663     // Attempt info.
1664     $a->attemptduedate     = userdate($duedate);
1665     $a->attemptgraceend    = userdate($graceend);
1666     $a->attemptsummaryurl  = $attemptobj->summary_url()->out(false);
1667     $a->attemptsummarylink = '<a href="' . $a->attemptsummaryurl . '">' . $quizname . ' review</a>';
1668     // Student's info.
1669     $a->studentidnumber    = $submitter->idnumber;
1670     $a->studentname        = fullname($submitter);
1671     $a->studentusername    = $submitter->username;
1673     // Prepare the message.
1674     $eventdata = new stdClass();
1675     $eventdata->component         = 'mod_quiz';
1676     $eventdata->name              = 'attempt_overdue';
1677     $eventdata->notification      = 1;
1679     $eventdata->userfrom          = core_user::get_noreply_user();
1680     $eventdata->userto            = $submitter;
1681     $eventdata->subject           = get_string('emailoverduesubject', 'quiz', $a);
1682     $eventdata->fullmessage       = get_string('emailoverduebody', 'quiz', $a);
1683     $eventdata->fullmessageformat = FORMAT_PLAIN;
1684     $eventdata->fullmessagehtml   = '';
1686     $eventdata->smallmessage      = get_string('emailoverduesmall', 'quiz', $a);
1687     $eventdata->contexturl        = $a->quizurl;
1688     $eventdata->contexturlname    = $a->quizname;
1690     // Send the message.
1691     return message_send($eventdata);
1694 /**
1695  * Handle the quiz_attempt_submitted event.
1696  *
1697  * This sends the confirmation and notification messages, if required.
1698  *
1699  * @param object $event the event object.
1700  */
1701 function quiz_attempt_submitted_handler($event) {
1702     global $DB;
1704     $course  = $DB->get_record('course', array('id' => $event->courseid));
1705     $attempt = $event->get_record_snapshot('quiz_attempts', $event->objectid);
1706     $quiz    = $event->get_record_snapshot('quiz', $attempt->quiz);
1707     $cm      = get_coursemodule_from_id('quiz', $event->get_context()->instanceid, $event->courseid);
1709     if (!($course && $quiz && $cm && $attempt)) {
1710         // Something has been deleted since the event was raised. Therefore, the
1711         // event is no longer relevant.
1712         return true;
1713     }
1715     // Update completion state.
1716     $completion = new completion_info($course);
1717     if ($completion->is_enabled($cm) && ($quiz->completionattemptsexhausted || $quiz->completionpass)) {
1718         $completion->update_state($cm, COMPLETION_COMPLETE, $event->userid);
1719     }
1720     return quiz_send_notification_messages($course, $quiz, $attempt,
1721             context_module::instance($cm->id), $cm);
1724 /**
1725  * Handle groups_member_added event
1726  *
1727  * @param object $event the event object.
1728  * @deprecated since 2.6, see {@link \mod_quiz\group_observers::group_member_added()}.
1729  */
1730 function quiz_groups_member_added_handler($event) {
1731     debugging('quiz_groups_member_added_handler() is deprecated, please use ' .
1732         '\mod_quiz\group_observers::group_member_added() instead.', DEBUG_DEVELOPER);
1733     quiz_update_open_attempts(array('userid'=>$event->userid, 'groupid'=>$event->groupid));
1736 /**
1737  * Handle groups_member_removed event
1738  *
1739  * @param object $event the event object.
1740  * @deprecated since 2.6, see {@link \mod_quiz\group_observers::group_member_removed()}.
1741  */
1742 function quiz_groups_member_removed_handler($event) {
1743     debugging('quiz_groups_member_removed_handler() is deprecated, please use ' .
1744         '\mod_quiz\group_observers::group_member_removed() instead.', DEBUG_DEVELOPER);
1745     quiz_update_open_attempts(array('userid'=>$event->userid, 'groupid'=>$event->groupid));
1748 /**
1749  * Handle groups_group_deleted event
1750  *
1751  * @param object $event the event object.
1752  * @deprecated since 2.6, see {@link \mod_quiz\group_observers::group_deleted()}.
1753  */
1754 function quiz_groups_group_deleted_handler($event) {
1755     global $DB;
1756     debugging('quiz_groups_group_deleted_handler() is deprecated, please use ' .
1757         '\mod_quiz\group_observers::group_deleted() instead.', DEBUG_DEVELOPER);
1758     quiz_process_group_deleted_in_course($event->courseid);
1761 /**
1762  * Logic to happen when a/some group(s) has/have been deleted in a course.
1763  *
1764  * @param int $courseid The course ID.
1765  * @return void
1766  */
1767 function quiz_process_group_deleted_in_course($courseid) {
1768     global $DB;
1770     // It would be nice if we got the groupid that was deleted.
1771     // Instead, we just update all quizzes with orphaned group overrides.
1772     $sql = "SELECT o.id, o.quiz
1773               FROM {quiz_overrides} o
1774               JOIN {quiz} quiz ON quiz.id = o.quiz
1775          LEFT JOIN {groups} grp ON grp.id = o.groupid
1776              WHERE quiz.course = :courseid
1777                AND o.groupid IS NOT NULL
1778                AND grp.id IS NULL";
1779     $params = array('courseid' => $courseid);
1780     $records = $DB->get_records_sql_menu($sql, $params);
1781     if (!$records) {
1782         return; // Nothing to do.
1783     }
1784     $DB->delete_records_list('quiz_overrides', 'id', array_keys($records));
1785     quiz_update_open_attempts(array('quizid' => array_unique(array_values($records))));
1788 /**
1789  * Handle groups_members_removed event
1790  *
1791  * @param object $event the event object.
1792  * @deprecated since 2.6, see {@link \mod_quiz\group_observers::group_member_removed()}.
1793  */
1794 function quiz_groups_members_removed_handler($event) {
1795     debugging('quiz_groups_members_removed_handler() is deprecated, please use ' .
1796         '\mod_quiz\group_observers::group_member_removed() instead.', DEBUG_DEVELOPER);
1797     if ($event->userid == 0) {
1798         quiz_update_open_attempts(array('courseid'=>$event->courseid));
1799     } else {
1800         quiz_update_open_attempts(array('courseid'=>$event->courseid, 'userid'=>$event->userid));
1801     }
1804 /**
1805  * Get the information about the standard quiz JavaScript module.
1806  * @return array a standard jsmodule structure.
1807  */
1808 function quiz_get_js_module() {
1809     global $PAGE;
1811     return array(
1812         'name' => 'mod_quiz',
1813         'fullpath' => '/mod/quiz/module.js',
1814         'requires' => array('base', 'dom', 'event-delegate', 'event-key',
1815                 'core_question_engine', 'moodle-core-formchangechecker'),
1816         'strings' => array(
1817             array('cancel', 'moodle'),
1818             array('flagged', 'question'),
1819             array('functiondisabledbysecuremode', 'quiz'),
1820             array('startattempt', 'quiz'),
1821             array('timesup', 'quiz'),
1822             array('changesmadereallygoaway', 'moodle'),
1823         ),
1824     );
1828 /**
1829  * An extension of question_display_options that includes the extra options used
1830  * by the quiz.
1831  *
1832  * @copyright  2010 The Open University
1833  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1834  */
1835 class mod_quiz_display_options extends question_display_options {
1836     /**#@+
1837      * @var integer bits used to indicate various times in relation to a
1838      * quiz attempt.
1839      */
1840     const DURING =            0x10000;
1841     const IMMEDIATELY_AFTER = 0x01000;
1842     const LATER_WHILE_OPEN =  0x00100;
1843     const AFTER_CLOSE =       0x00010;
1844     /**#@-*/
1846     /**
1847      * @var boolean if this is false, then the student is not allowed to review
1848      * anything about the attempt.
1849      */
1850     public $attempt = true;
1852     /**
1853      * @var boolean if this is false, then the student is not allowed to review
1854      * anything about the attempt.
1855      */
1856     public $overallfeedback = self::VISIBLE;
1858     /**
1859      * Set up the various options from the quiz settings, and a time constant.
1860      * @param object $quiz the quiz settings.
1861      * @param int $one of the {@link DURING}, {@link IMMEDIATELY_AFTER},
1862      * {@link LATER_WHILE_OPEN} or {@link AFTER_CLOSE} constants.
1863      * @return mod_quiz_display_options set up appropriately.
1864      */
1865     public static function make_from_quiz($quiz, $when) {
1866         $options = new self();
1868         $options->attempt = self::extract($quiz->reviewattempt, $when, true, false);
1869         $options->correctness = self::extract($quiz->reviewcorrectness, $when);
1870         $options->marks = self::extract($quiz->reviewmarks, $when,
1871                 self::MARK_AND_MAX, self::MAX_ONLY);
1872         $options->feedback = self::extract($quiz->reviewspecificfeedback, $when);
1873         $options->generalfeedback = self::extract($quiz->reviewgeneralfeedback, $when);
1874         $options->rightanswer = self::extract($quiz->reviewrightanswer, $when);
1875         $options->overallfeedback = self::extract($quiz->reviewoverallfeedback, $when);
1877         $options->numpartscorrect = $options->feedback;
1878         $options->manualcomment = $options->feedback;
1880         if ($quiz->questiondecimalpoints != -1) {
1881             $options->markdp = $quiz->questiondecimalpoints;
1882         } else {
1883             $options->markdp = $quiz->decimalpoints;
1884         }
1886         return $options;
1887     }
1889     protected static function extract($bitmask, $bit,
1890             $whenset = self::VISIBLE, $whennotset = self::HIDDEN) {
1891         if ($bitmask & $bit) {
1892             return $whenset;
1893         } else {
1894             return $whennotset;
1895         }
1896     }
1900 /**
1901  * A {@link qubaid_condition} for finding all the question usages belonging to
1902  * a particular quiz.
1903  *
1904  * @copyright  2010 The Open University
1905  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1906  */
1907 class qubaids_for_quiz extends qubaid_join {
1908     public function __construct($quizid, $includepreviews = true, $onlyfinished = false) {
1909         $where = 'quiza.quiz = :quizaquiz';
1910         $params = array('quizaquiz' => $quizid);
1912         if (!$includepreviews) {
1913             $where .= ' AND preview = 0';
1914         }
1916         if ($onlyfinished) {
1917             $where .= ' AND state == :statefinished';
1918             $params['statefinished'] = quiz_attempt::FINISHED;
1919         }
1921         parent::__construct('{quiz_attempts} quiza', 'quiza.uniqueid', $where, $params);
1922     }
1925 /**
1926  * Creates a textual representation of a question for display.
1927  *
1928  * @param object $question A question object from the database questions table
1929  * @param bool $showicon If true, show the question's icon with the question. False by default.
1930  * @param bool $showquestiontext If true (default), show question text after question name.
1931  *       If false, show only question name.
1932  * @return string
1933  */
1934 function quiz_question_tostring($question, $showicon = false, $showquestiontext = true) {
1935     $result = '';
1937     $name = shorten_text(format_string($question->name), 200);
1938     if ($showicon) {
1939         $name .= print_question_icon($question) . ' ' . $name;
1940     }
1941     $result .= html_writer::span($name, 'questionname');
1943     if ($showquestiontext) {
1944         $questiontext = question_utils::to_plain_text($question->questiontext,
1945                 $question->questiontextformat, array('noclean' => true, 'para' => false));
1946         $questiontext = shorten_text($questiontext, 200);
1947         if ($questiontext) {
1948             $result .= ' ' . html_writer::span(s($questiontext), 'questiontext');
1949         }
1950     }
1952     return $result;
1955 /**
1956  * Verify that the question exists, and the user has permission to use it.
1957  * Does not return. Throws an exception if the question cannot be used.
1958  * @param int $questionid The id of the question.
1959  */
1960 function quiz_require_question_use($questionid) {
1961     global $DB;
1962     $question = $DB->get_record('question', array('id' => $questionid), '*', MUST_EXIST);
1963     question_require_capability_on($question, 'use');
1966 /**
1967  * Verify that the question exists, and the user has permission to use it.
1968  * @param object $quiz the quiz settings.
1969  * @param int $slot which question in the quiz to test.
1970  * @return bool whether the user can use this question.
1971  */
1972 function quiz_has_question_use($quiz, $slot) {
1973     global $DB;
1974     $question = $DB->get_record_sql("
1975             SELECT q.*
1976               FROM {quiz_slots} slot
1977               JOIN {question} q ON q.id = slot.questionid
1978              WHERE slot.quizid = ? AND slot.slot = ?", array($quiz->id, $slot));
1979     if (!$question) {
1980         return false;
1981     }
1982     return question_has_capability_on($question, 'use');
1985 /**
1986  * Add a question to a quiz
1987  *
1988  * Adds a question to a quiz by updating $quiz as well as the
1989  * quiz and quiz_slots tables. It also adds a page break if required.
1990  * @param int $questionid The id of the question to be added
1991  * @param object $quiz The extended quiz object as used by edit.php
1992  *      This is updated by this function
1993  * @param int $page Which page in quiz to add the question on. If 0 (default),
1994  *      add at the end
1995  * @param float $maxmark The maximum mark to set for this question. (Optional,
1996  *      defaults to question.defaultmark.
1997  * @return bool false if the question was already in the quiz
1998  */
1999 function quiz_add_quiz_question($questionid, $quiz, $page = 0, $maxmark = null) {
2000     global $DB;
2001     $slots = $DB->get_records('quiz_slots', array('quizid' => $quiz->id),
2002             'slot', 'questionid, slot, page, id');
2003     if (array_key_exists($questionid, $slots)) {
2004         return false;
2005     }
2007     $trans = $DB->start_delegated_transaction();
2009     $maxpage = 1;
2010     $numonlastpage = 0;
2011     foreach ($slots as $slot) {
2012         if ($slot->page > $maxpage) {
2013             $maxpage = $slot->page;
2014             $numonlastpage = 1;
2015         } else {
2016             $numonlastpage += 1;
2017         }
2018     }
2020     // Add the new question instance.
2021     $slot = new stdClass();
2022     $slot->quizid = $quiz->id;
2023     $slot->questionid = $questionid;
2025     if ($maxmark !== null) {
2026         $slot->maxmark = $maxmark;
2027     } else {
2028         $slot->maxmark = $DB->get_field('question', 'defaultmark', array('id' => $questionid));
2029     }
2031     if (is_int($page) && $page >= 1) {
2032         // Adding on a given page.
2033         $lastslotbefore = 0;
2034         foreach (array_reverse($slots) as $otherslot) {
2035             if ($otherslot->page > $page) {
2036                 $DB->set_field('quiz_slots', 'slot', $otherslot->slot + 1, array('id' => $otherslot->id));
2037             } else {
2038                 $lastslotbefore = $otherslot->slot;
2039                 break;
2040             }
2041         }
2042         $slot->slot = $lastslotbefore + 1;
2043         $slot->page = min($page, $maxpage + 1);
2045         $DB->execute("
2046                 UPDATE {quiz_sections}
2047                    SET firstslot = firstslot + 1
2048                  WHERE quizid = ?
2049                    AND firstslot > ?
2050                 ", array($quiz->id, max($lastslotbefore, 1)));
2052     } else {
2053         $lastslot = end($slots);
2054         if ($lastslot) {
2055             $slot->slot = $lastslot->slot + 1;
2056         } else {
2057             $slot->slot = 1;
2058         }
2059         if ($quiz->questionsperpage && $numonlastpage >= $quiz->questionsperpage) {
2060             $slot->page = $maxpage + 1;
2061         } else {
2062             $slot->page = $maxpage;
2063         }
2064     }
2066     $DB->insert_record('quiz_slots', $slot);
2067     $trans->allow_commit();
2070 /**
2071  * Add a random question to the quiz at a given point.
2072  * @param object $quiz the quiz settings.
2073  * @param int $addonpage the page on which to add the question.
2074  * @param int $categoryid the question category to add the question from.
2075  * @param int $number the number of random questions to add.
2076  * @param bool $includesubcategories whether to include questoins from subcategories.
2077  */
2078 function quiz_add_random_questions($quiz, $addonpage, $categoryid, $number,
2079         $includesubcategories) {
2080     global $DB;
2082     $category = $DB->get_record('question_categories', array('id' => $categoryid));
2083     if (!$category) {
2084         print_error('invalidcategoryid', 'error');
2085     }
2087     $catcontext = context::instance_by_id($category->contextid);
2088     require_capability('moodle/question:useall', $catcontext);
2090     // Find existing random questions in this category that are
2091     // not used by any quiz.
2092     if ($existingquestions = $DB->get_records_sql(
2093             "SELECT q.id, q.qtype FROM {question} q
2094             WHERE qtype = 'random'
2095                 AND category = ?
2096                 AND " . $DB->sql_compare_text('questiontext') . " = ?
2097                 AND NOT EXISTS (
2098                         SELECT *
2099                           FROM {quiz_slots}
2100                          WHERE questionid = q.id)
2101             ORDER BY id", array($category->id, ($includesubcategories ? '1' : '0')))) {
2102             // Take as many of these as needed.
2103         while (($existingquestion = array_shift($existingquestions)) && $number > 0) {
2104             quiz_add_quiz_question($existingquestion->id, $quiz, $addonpage);
2105             $number -= 1;
2106         }
2107     }
2109     if ($number <= 0) {
2110         return;
2111     }
2113     // More random questions are needed, create them.
2114     for ($i = 0; $i < $number; $i += 1) {
2115         $form = new stdClass();
2116         $form->questiontext = array('text' => ($includesubcategories ? '1' : '0'), 'format' => 0);
2117         $form->category = $category->id . ',' . $category->contextid;
2118         $form->defaultmark = 1;
2119         $form->hidden = 1;
2120         $form->stamp = make_unique_id_code(); // Set the unique code (not to be changed).
2121         $question = new stdClass();
2122         $question->qtype = 'random';
2123         $question = question_bank::get_qtype('random')->save_question($question, $form);
2124         if (!isset($question->id)) {
2125             print_error('cannotinsertrandomquestion', 'quiz');
2126         }
2127         quiz_add_quiz_question($question->id, $quiz, $addonpage);
2128     }
2131 /**
2132  * Mark the activity completed (if required) and trigger the course_module_viewed event.
2133  *
2134  * @param  stdClass $quiz       quiz object
2135  * @param  stdClass $course     course object
2136  * @param  stdClass $cm         course module object
2137  * @param  stdClass $context    context object
2138  * @since Moodle 3.1
2139  */
2140 function quiz_view($quiz, $course, $cm, $context) {
2142     $params = array(
2143         'objectid' => $quiz->id,
2144         'context' => $context
2145     );
2147     $event = \mod_quiz\event\course_module_viewed::create($params);
2148     $event->add_record_snapshot('quiz', $quiz);
2149     $event->trigger();
2151     // Completion.
2152     $completion = new completion_info($course);
2153     $completion->set_module_viewed($cm);
2156 /**
2157  * Validate permissions for creating a new attempt and start a new preview attempt if required.
2158  *
2159  * @param  quiz $quizobj quiz object
2160  * @param  quiz_access_manager $accessmanager quiz access manager
2161  * @param  bool $forcenew whether was required to start a new preview attempt
2162  * @param  int $page page to jump to in the attempt
2163  * @param  bool $redirect whether to redirect or throw exceptions (for web or ws usage)
2164  * @return array an array containing the attempt information, access error messages and the page to jump to in the attempt
2165  * @throws moodle_quiz_exception
2166  * @since Moodle 3.1
2167  */
2168 function quiz_validate_new_attempt(quiz $quizobj, quiz_access_manager $accessmanager, $forcenew, $page, $redirect) {
2169     global $DB, $USER;
2170     $timenow = time();
2172     if ($quizobj->is_preview_user() && $forcenew) {
2173         $accessmanager->current_attempt_finished();
2174     }
2176     // Check capabilities.
2177     if (!$quizobj->is_preview_user()) {
2178         $quizobj->require_capability('mod/quiz:attempt');
2179     }
2181     // Check to see if a new preview was requested.
2182     if ($quizobj->is_preview_user() && $forcenew) {
2183         // To force the creation of a new preview, we mark the current attempt (if any)
2184         // as finished. It will then automatically be deleted below.
2185         $DB->set_field('quiz_attempts', 'state', quiz_attempt::FINISHED,
2186                 array('quiz' => $quizobj->get_quizid(), 'userid' => $USER->id));
2187     }
2189     // Look for an existing attempt.
2190     $attempts = quiz_get_user_attempts($quizobj->get_quizid(), $USER->id, 'all', true);
2191     $lastattempt = end($attempts);
2193     $attemptnumber = null;
2194     // If an in-progress attempt exists, check password then redirect to it.
2195     if ($lastattempt && ($lastattempt->state == quiz_attempt::IN_PROGRESS ||
2196             $lastattempt->state == quiz_attempt::OVERDUE)) {
2197         $currentattemptid = $lastattempt->id;
2198         $messages = $accessmanager->prevent_access();
2200         // If the attempt is now overdue, deal with that.
2201         $quizobj->create_attempt_object($lastattempt)->handle_if_time_expired($timenow, true);
2203         // And, if the attempt is now no longer in progress, redirect to the appropriate place.
2204         if ($lastattempt->state == quiz_attempt::ABANDONED || $lastattempt->state == quiz_attempt::FINISHED) {
2205             if ($redirect) {
2206                 redirect($quizobj->review_url($lastattempt->id));
2207             } else {
2208                 throw new moodle_quiz_exception($quizobj, 'attemptalreadyclosed');
2209             }
2210         }
2212         // If the page number was not explicitly in the URL, go to the current page.
2213         if ($page == -1) {
2214             $page = $lastattempt->currentpage;
2215         }
2217     } else {
2218         while ($lastattempt && $lastattempt->preview) {
2219             $lastattempt = array_pop($attempts);
2220         }
2222         // Get number for the next or unfinished attempt.
2223         if ($lastattempt) {
2224             $attemptnumber = $lastattempt->attempt + 1;
2225         } else {
2226             $lastattempt = false;
2227             $attemptnumber = 1;
2228         }
2229         $currentattemptid = null;
2231         $messages = $accessmanager->prevent_access() +
2232             $accessmanager->prevent_new_attempt(count($attempts), $lastattempt);
2234         if ($page == -1) {
2235             $page = 0;
2236         }
2237     }
2238     return array($currentattemptid, $attemptnumber, $lastattempt, $messages, $page);
2241 /**
2242  * Prepare and start a new attempt deleting the previous preview attempts.
2243  *
2244  * @param  quiz $quizobj quiz object
2245  * @param  int $attemptnumber the attempt number
2246  * @param  object $lastattempt last attempt object
2247  * @return object the new attempt
2248  * @since  Moodle 3.1
2249  */
2250 function quiz_prepare_and_start_new_attempt(quiz $quizobj, $attemptnumber, $lastattempt) {
2251     global $DB, $USER;
2253     // Delete any previous preview attempts belonging to this user.
2254     quiz_delete_previews($quizobj->get_quiz(), $USER->id);
2256     $quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());
2257     $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);
2259     // Create the new attempt and initialize the question sessions
2260     $timenow = time(); // Update time now, in case the server is running really slowly.
2261     $attempt = quiz_create_attempt($quizobj, $attemptnumber, $lastattempt, $timenow, $quizobj->is_preview_user());
2263     if (!($quizobj->get_quiz()->attemptonlast && $lastattempt)) {
2264         $attempt = quiz_start_new_attempt($quizobj, $quba, $attempt, $attemptnumber, $timenow);
2265     } else {
2266         $attempt = quiz_start_attempt_built_on_last($quba, $attempt, $lastattempt);
2267     }
2269     $transaction = $DB->start_delegated_transaction();
2271     $attempt = quiz_attempt_save_started($quizobj, $quba, $attempt);
2273     $transaction->allow_commit();
2275     return $attempt;