Merge branch 'w18_MDL-32589_m23_proxytest' of git://github.com/skodak/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
27  * @subpackage quiz
28  * @copyright  1999 onwards Martin Dougiamas and others {@link http://moodle.com}
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
33 defined('MOODLE_INTERNAL') || die();
35 require_once($CFG->dirroot . '/mod/quiz/lib.php');
36 require_once($CFG->dirroot . '/mod/quiz/accessmanager.php');
37 require_once($CFG->dirroot . '/mod/quiz/accessmanager_form.php');
38 require_once($CFG->dirroot . '/mod/quiz/renderer.php');
39 require_once($CFG->dirroot . '/mod/quiz/attemptlib.php');
40 require_once($CFG->dirroot . '/question/editlib.php');
41 require_once($CFG->libdir  . '/eventslib.php');
42 require_once($CFG->libdir . '/filelib.php');
45 /**
46  * 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');
59 /// Functions related to attempts /////////////////////////////////////////
61 /**
62  * Creates an object to represent a new attempt at a quiz
63  *
64  * Creates an attempt object to represent an attempt at the quiz by the current
65  * user starting at the current time. The ->id field is not set. The object is
66  * NOT written to the database.
67  *
68  * @param object $quiz the quiz to create an attempt for.
69  * @param int $attemptnumber the sequence number for the attempt.
70  * @param object $lastattempt the previous attempt by this user, if any. Only needed
71  *         if $attemptnumber > 1 and $quiz->attemptonlast is true.
72  * @param int $timenow the time the attempt was started at.
73  * @param bool $ispreview whether this new attempt is a preview.
74  *
75  * @return object the newly created attempt object.
76  */
77 function quiz_create_attempt($quiz, $attemptnumber, $lastattempt, $timenow, $ispreview = false) {
78     global $USER;
80     if ($quiz->sumgrades < 0.000005 && $quiz->grade > 0.000005) {
81         throw new moodle_exception('cannotstartgradesmismatch', 'quiz',
82                 new moodle_url('/mod/quiz/view.php', array('q' => $quiz->id)),
83                     array('grade' => quiz_format_grade($quiz, $quiz->grade)));
84     }
86     if ($attemptnumber == 1 || !$quiz->attemptonlast) {
87         // We are not building on last attempt so create a new attempt.
88         $attempt = new stdClass();
89         $attempt->quiz = $quiz->id;
90         $attempt->userid = $USER->id;
91         $attempt->preview = 0;
92         $attempt->layout = quiz_clean_layout($quiz->questions, true);
93         if ($quiz->shufflequestions) {
94             $attempt->layout = quiz_repaginate($attempt->layout, $quiz->questionsperpage, true);
95         }
96     } else {
97         // Build on last attempt.
98         if (empty($lastattempt)) {
99             print_error('cannotfindprevattempt', 'quiz');
100         }
101         $attempt = $lastattempt;
102     }
104     $attempt->attempt = $attemptnumber;
105     $attempt->timestart = $timenow;
106     $attempt->timefinish = 0;
107     $attempt->timemodified = $timenow;
108     $attempt->state = quiz_attempt::IN_PROGRESS;
110     // If this is a preview, mark it as such.
111     if ($ispreview) {
112         $attempt->preview = 1;
113     }
115     return $attempt;
118 /**
119  * Returns an unfinished attempt (if there is one) for the given
120  * user on the given quiz. This function does not return preview attempts.
121  *
122  * @param int $quizid the id of the quiz.
123  * @param int $userid the id of the user.
124  *
125  * @return mixed the unfinished attempt if there is one, false if not.
126  */
127 function quiz_get_user_attempt_unfinished($quizid, $userid) {
128     $attempts = quiz_get_user_attempts($quizid, $userid, 'unfinished', true);
129     if ($attempts) {
130         return array_shift($attempts);
131     } else {
132         return false;
133     }
136 /**
137  * Delete a quiz attempt.
138  * @param mixed $attempt an integer attempt id or an attempt object
139  *      (row of the quiz_attempts table).
140  * @param object $quiz the quiz object.
141  */
142 function quiz_delete_attempt($attempt, $quiz) {
143     global $DB;
144     if (is_numeric($attempt)) {
145         if (!$attempt = $DB->get_record('quiz_attempts', array('id' => $attempt))) {
146             return;
147         }
148     }
150     if ($attempt->quiz != $quiz->id) {
151         debugging("Trying to delete attempt $attempt->id which belongs to quiz $attempt->quiz " .
152                 "but was passed quiz $quiz->id.");
153         return;
154     }
156     question_engine::delete_questions_usage_by_activity($attempt->uniqueid);
157     $DB->delete_records('quiz_attempts', array('id' => $attempt->id));
159     // Search quiz_attempts for other instances by this user.
160     // If none, then delete record for this quiz, this user from quiz_grades
161     // else recalculate best grade
162     $userid = $attempt->userid;
163     if (!$DB->record_exists('quiz_attempts', array('userid' => $userid, 'quiz' => $quiz->id))) {
164         $DB->delete_records('quiz_grades', array('userid' => $userid, 'quiz' => $quiz->id));
165     } else {
166         quiz_save_best_grade($quiz, $userid);
167     }
169     quiz_update_grades($quiz, $userid);
172 /**
173  * Delete all the preview attempts at a quiz, or possibly all the attempts belonging
174  * to one user.
175  * @param object $quiz the quiz object.
176  * @param int $userid (optional) if given, only delete the previews belonging to this user.
177  */
178 function quiz_delete_previews($quiz, $userid = null) {
179     global $DB;
180     $conditions = array('quiz' => $quiz->id, 'preview' => 1);
181     if (!empty($userid)) {
182         $conditions['userid'] = $userid;
183     }
184     $previewattempts = $DB->get_records('quiz_attempts', $conditions);
185     foreach ($previewattempts as $attempt) {
186         quiz_delete_attempt($attempt, $quiz);
187     }
190 /**
191  * @param int $quizid The quiz id.
192  * @return bool whether this quiz has any (non-preview) attempts.
193  */
194 function quiz_has_attempts($quizid) {
195     global $DB;
196     return $DB->record_exists('quiz_attempts', array('quiz' => $quizid, 'preview' => 0));
199 /// Functions to do with quiz layout and pages ////////////////////////////////
201 /**
202  * Returns a comma separated list of question ids for the quiz
203  *
204  * @param string $layout The string representing the quiz layout. Each page is
205  *      represented as a comma separated list of question ids and 0 indicating
206  *      page breaks. So 5,2,0,3,0 means questions 5 and 2 on page 1 and question
207  *      3 on page 2
208  * @return string comma separated list of question ids, without page breaks.
209  */
210 function quiz_questions_in_quiz($layout) {
211     $questions = str_replace(',0', '', quiz_clean_layout($layout, true));
212     if ($questions === '0') {
213         return '';
214     } else {
215         return $questions;
216     }
219 /**
220  * Returns the number of pages in a quiz layout
221  *
222  * @param string $layout The string representing the quiz layout. Always ends in ,0
223  * @return int The number of pages in the quiz.
224  */
225 function quiz_number_of_pages($layout) {
226     return substr_count(',' . $layout, ',0');
229 /**
230  * Returns the number of questions in the quiz layout
231  *
232  * @param string $layout the string representing the quiz layout.
233  * @return int The number of questions in the quiz.
234  */
235 function quiz_number_of_questions_in_quiz($layout) {
236     $layout = quiz_questions_in_quiz(quiz_clean_layout($layout));
237     $count = substr_count($layout, ',');
238     if ($layout !== '') {
239         $count++;
240     }
241     return $count;
244 /**
245  * Re-paginates the quiz layout
246  *
247  * @param string $layout  The string representing the quiz layout. If there is
248  *      if there is any doubt about the quality of the input data, call
249  *      quiz_clean_layout before you call this function.
250  * @param int $perpage The number of questions per page
251  * @param bool $shuffle Should the questions be reordered randomly?
252  * @return string the new layout string
253  */
254 function quiz_repaginate($layout, $perpage, $shuffle = false) {
255     $questions = quiz_questions_in_quiz($layout);
256     if (!$questions) {
257         return '0';
258     }
260     $questions = explode(',', quiz_questions_in_quiz($layout));
261     if ($shuffle) {
262         shuffle($questions);
263     }
265     $onthispage = 0;
266     $layout = array();
267     foreach ($questions as $question) {
268         if ($perpage and $onthispage >= $perpage) {
269             $layout[] = 0;
270             $onthispage = 0;
271         }
272         $layout[] = $question;
273         $onthispage += 1;
274     }
276     $layout[] = 0;
277     return implode(',', $layout);
280 /// Functions to do with quiz grades //////////////////////////////////////////
282 /**
283  * Creates an array of maximum grades for a quiz
284  *
285  * The grades are extracted from the quiz_question_instances table.
286  * @param object $quiz The quiz settings.
287  * @return array of grades indexed by question id. These are the maximum
288  *      possible grades that students can achieve for each of the questions.
289  */
290 function quiz_get_all_question_grades($quiz) {
291     global $CFG, $DB;
293     $questionlist = quiz_questions_in_quiz($quiz->questions);
294     if (empty($questionlist)) {
295         return array();
296     }
298     $params = array($quiz->id);
299     $wheresql = '';
300     if (!is_null($questionlist)) {
301         list($usql, $question_params) = $DB->get_in_or_equal(explode(',', $questionlist));
302         $wheresql = " AND question $usql ";
303         $params = array_merge($params, $question_params);
304     }
306     $instances = $DB->get_records_sql("SELECT question, grade, id
307                                     FROM {quiz_question_instances}
308                                     WHERE quiz = ? $wheresql", $params);
310     $list = explode(",", $questionlist);
311     $grades = array();
313     foreach ($list as $qid) {
314         if (isset($instances[$qid])) {
315             $grades[$qid] = $instances[$qid]->grade;
316         } else {
317             $grades[$qid] = 1;
318         }
319     }
320     return $grades;
323 /**
324  * Convert the raw grade stored in $attempt into a grade out of the maximum
325  * grade for this quiz.
326  *
327  * @param float $rawgrade the unadjusted grade, fof example $attempt->sumgrades
328  * @param object $quiz the quiz object. Only the fields grade, sumgrades and decimalpoints are used.
329  * @param bool|string $format whether to format the results for display
330  *      or 'question' to format a question grade (different number of decimal places.
331  * @return float|string the rescaled grade, or null/the lang string 'notyetgraded'
332  *      if the $grade is null.
333  */
334 function quiz_rescale_grade($rawgrade, $quiz, $format = true) {
335     if (is_null($rawgrade)) {
336         $grade = null;
337     } else if ($quiz->sumgrades >= 0.000005) {
338         $grade = $rawgrade * $quiz->grade / $quiz->sumgrades;
339     } else {
340         $grade = 0;
341     }
342     if ($format === 'question') {
343         $grade = quiz_format_question_grade($quiz, $grade);
344     } else if ($format) {
345         $grade = quiz_format_grade($quiz, $grade);
346     }
347     return $grade;
350 /**
351  * Get the feedback text that should be show to a student who
352  * got this grade on this quiz. The feedback is processed ready for diplay.
353  *
354  * @param float $grade a grade on this quiz.
355  * @param object $quiz the quiz settings.
356  * @param object $context the quiz context.
357  * @return string the comment that corresponds to this grade (empty string if there is not one.
358  */
359 function quiz_feedback_for_grade($grade, $quiz, $context) {
360     global $DB;
362     if (is_null($grade)) {
363         return '';
364     }
366     // With CBM etc, it is possible to get -ve grades, which would then not match
367     // any feedback. Therefore, we replace -ve grades with 0.
368     $grade = max($grade, 0);
370     $feedback = $DB->get_record_select('quiz_feedback',
371             'quizid = ? AND mingrade <= ? AND ? < maxgrade', array($quiz->id, $grade, $grade));
373     if (empty($feedback->feedbacktext)) {
374         return '';
375     }
377     // Clean the text, ready for display.
378     $formatoptions = new stdClass();
379     $formatoptions->noclean = true;
380     $feedbacktext = file_rewrite_pluginfile_urls($feedback->feedbacktext, 'pluginfile.php',
381             $context->id, 'mod_quiz', 'feedback', $feedback->id);
382     $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
384     return $feedbacktext;
387 /**
388  * @param object $quiz the quiz database row.
389  * @return bool Whether this quiz has any non-blank feedback text.
390  */
391 function quiz_has_feedback($quiz) {
392     global $DB;
393     static $cache = array();
394     if (!array_key_exists($quiz->id, $cache)) {
395         $cache[$quiz->id] = quiz_has_grades($quiz) &&
396                 $DB->record_exists_select('quiz_feedback', "quizid = ? AND " .
397                     $DB->sql_isnotempty('quiz_feedback', 'feedbacktext', false, true),
398                 array($quiz->id));
399     }
400     return $cache[$quiz->id];
403 /**
404  * Update the sumgrades field of the quiz. This needs to be called whenever
405  * the grading structure of the quiz is changed. For example if a question is
406  * added or removed, or a question weight is changed.
407  *
408  * You should call {@link quiz_delete_previews()} before you call this function.
409  *
410  * @param object $quiz a quiz.
411  */
412 function quiz_update_sumgrades($quiz) {
413     global $DB;
415     $sql = 'UPDATE {quiz}
416             SET sumgrades = COALESCE((
417                 SELECT SUM(grade)
418                 FROM {quiz_question_instances}
419                 WHERE quiz = {quiz}.id
420             ), 0)
421             WHERE id = ?';
422     $DB->execute($sql, array($quiz->id));
423     $quiz->sumgrades = $DB->get_field('quiz', 'sumgrades', array('id' => $quiz->id));
425     if ($quiz->sumgrades < 0.000005 && quiz_has_attempts($quiz->id)) {
426         // If the quiz has been attempted, and the sumgrades has been
427         // set to 0, then we must also set the maximum possible grade to 0, or
428         // we will get a divide by zero error.
429         quiz_set_grade(0, $quiz);
430     }
433 /**
434  * Update the sumgrades field of the attempts at a quiz.
435  *
436  * @param object $quiz a quiz.
437  */
438 function quiz_update_all_attempt_sumgrades($quiz) {
439     global $DB;
440     $dm = new question_engine_data_mapper();
441     $timenow = time();
443     $sql = "UPDATE {quiz_attempts}
444             SET
445                 timemodified = :timenow,
446                 sumgrades = (
447                     {$dm->sum_usage_marks_subquery('uniqueid')}
448                 )
449             WHERE quiz = :quizid AND state = :finishedstate";
450     $DB->execute($sql, array('timenow' => $timenow, 'quizid' => $quiz->id,
451             'finishedstate' => quiz_attempt::FINISHED));
454 /**
455  * The quiz grade is the maximum that student's results are marked out of. When it
456  * changes, the corresponding data in quiz_grades and quiz_feedback needs to be
457  * rescaled. After calling this function, you probably need to call
458  * quiz_update_all_attempt_sumgrades, quiz_update_all_final_grades and
459  * quiz_update_grades.
460  *
461  * @param float $newgrade the new maximum grade for the quiz.
462  * @param object $quiz the quiz we are updating. Passed by reference so its
463  *      grade field can be updated too.
464  * @return bool indicating success or failure.
465  */
466 function quiz_set_grade($newgrade, $quiz) {
467     global $DB;
468     // This is potentially expensive, so only do it if necessary.
469     if (abs($quiz->grade - $newgrade) < 1e-7) {
470         // Nothing to do.
471         return true;
472     }
474     // Use a transaction, so that on those databases that support it, this is safer.
475     $transaction = $DB->start_delegated_transaction();
477     // Update the quiz table.
478     $DB->set_field('quiz', 'grade', $newgrade, array('id' => $quiz->instance));
480     // Rescaling the other data is only possible if the old grade was non-zero.
481     if ($quiz->grade > 1e-7) {
482         global $CFG;
484         $factor = $newgrade/$quiz->grade;
485         $quiz->grade = $newgrade;
487         // Update the quiz_grades table.
488         $timemodified = time();
489         $DB->execute("
490                 UPDATE {quiz_grades}
491                 SET grade = ? * grade, timemodified = ?
492                 WHERE quiz = ?
493         ", array($factor, $timemodified, $quiz->id));
495         // Update the quiz_feedback table.
496         $DB->execute("
497                 UPDATE {quiz_feedback}
498                 SET mingrade = ? * mingrade, maxgrade = ? * maxgrade
499                 WHERE quizid = ?
500         ", array($factor, $factor, $quiz->id));
501     }
503     // update grade item and send all grades to gradebook
504     quiz_grade_item_update($quiz);
505     quiz_update_grades($quiz);
507     $transaction->allow_commit();
508     return true;
511 /**
512  * Save the overall grade for a user at a quiz in the quiz_grades table
513  *
514  * @param object $quiz The quiz for which the best grade is to be calculated and then saved.
515  * @param int $userid The userid to calculate the grade for. Defaults to the current user.
516  * @param array $attempts The attempts of this user. Useful if you are
517  * looping through many users. Attempts can be fetched in one master query to
518  * avoid repeated querying.
519  * @return bool Indicates success or failure.
520  */
521 function quiz_save_best_grade($quiz, $userid = null, $attempts = array()) {
522     global $DB, $OUTPUT, $USER;
524     if (empty($userid)) {
525         $userid = $USER->id;
526     }
528     if (!$attempts) {
529         // Get all the attempts made by the user
530         $attempts = quiz_get_user_attempts($quiz->id, $userid);
531     }
533     // Calculate the best grade
534     $bestgrade = quiz_calculate_best_grade($quiz, $attempts);
535     $bestgrade = quiz_rescale_grade($bestgrade, $quiz, false);
537     // Save the best grade in the database
538     if (is_null($bestgrade)) {
539         $DB->delete_records('quiz_grades', array('quiz' => $quiz->id, 'userid' => $userid));
541     } else if ($grade = $DB->get_record('quiz_grades',
542             array('quiz' => $quiz->id, 'userid' => $userid))) {
543         $grade->grade = $bestgrade;
544         $grade->timemodified = time();
545         $DB->update_record('quiz_grades', $grade);
547     } else {
548         $grade = new stdClass();
549         $grade->quiz = $quiz->id;
550         $grade->userid = $userid;
551         $grade->grade = $bestgrade;
552         $grade->timemodified = time();
553         $DB->insert_record('quiz_grades', $grade);
554     }
556     quiz_update_grades($quiz, $userid);
559 /**
560  * Calculate the overall grade for a quiz given a number of attempts by a particular user.
561  *
562  * @param object $quiz    the quiz settings object.
563  * @param array $attempts an array of all the user's attempts at this quiz in order.
564  * @return float          the overall grade
565  */
566 function quiz_calculate_best_grade($quiz, $attempts) {
568     switch ($quiz->grademethod) {
570         case QUIZ_ATTEMPTFIRST:
571             $firstattempt = reset($attempts);
572             return $firstattempt->sumgrades;
574         case QUIZ_ATTEMPTLAST:
575             $lastattempt = end($attempts);
576             return $lastattempt->sumgrades;
578         case QUIZ_GRADEAVERAGE:
579             $sum = 0;
580             $count = 0;
581             foreach ($attempts as $attempt) {
582                 if (!is_null($attempt->sumgrades)) {
583                     $sum += $attempt->sumgrades;
584                     $count++;
585                 }
586             }
587             if ($count == 0) {
588                 return null;
589             }
590             return $sum / $count;
592         case QUIZ_GRADEHIGHEST:
593         default:
594             $max = null;
595             foreach ($attempts as $attempt) {
596                 if ($attempt->sumgrades > $max) {
597                     $max = $attempt->sumgrades;
598                 }
599             }
600             return $max;
601     }
604 /**
605  * Update the final grade at this quiz for all students.
606  *
607  * This function is equivalent to calling quiz_save_best_grade for all
608  * users, but much more efficient.
609  *
610  * @param object $quiz the quiz settings.
611  */
612 function quiz_update_all_final_grades($quiz) {
613     global $DB;
615     if (!$quiz->sumgrades) {
616         return;
617     }
619     $param = array('iquizid' => $quiz->id, 'istatefinished' => quiz_attempt::FINISHED);
620     $firstlastattemptjoin = "JOIN (
621             SELECT
622                 iquiza.userid,
623                 MIN(attempt) AS firstattempt,
624                 MAX(attempt) AS lastattempt
626             FROM {quiz_attempts} iquiza
628             WHERE
629                 iquiza.state = :istatefinished
630                 iquiza.preview = 0 AND
631                 iquiza.quiz = :iquizid
633             GROUP BY iquiza.userid
634         ) first_last_attempts ON first_last_attempts.userid = quiza.userid";
636     switch ($quiz->grademethod) {
637         case QUIZ_ATTEMPTFIRST:
638             // Because of the where clause, there will only be one row, but we
639             // must still use an aggregate function.
640             $select = 'MAX(quiza.sumgrades)';
641             $join = $firstlastattemptjoin;
642             $where = 'quiza.attempt = first_last_attempts.firstattempt AND';
643             break;
645         case QUIZ_ATTEMPTLAST:
646             // Because of the where clause, there will only be one row, but we
647             // must still use an aggregate function.
648             $select = 'MAX(quiza.sumgrades)';
649             $join = $firstlastattemptjoin;
650             $where = 'quiza.attempt = first_last_attempts.lastattempt AND';
651             break;
653         case QUIZ_GRADEAVERAGE:
654             $select = 'AVG(quiza.sumgrades)';
655             $join = '';
656             $where = '';
657             break;
659         default:
660         case QUIZ_GRADEHIGHEST:
661             $select = 'MAX(quiza.sumgrades)';
662             $join = '';
663             $where = '';
664             break;
665     }
667     if ($quiz->sumgrades >= 0.000005) {
668         $finalgrade = $select . ' * ' . ($quiz->grade / $quiz->sumgrades);
669     } else {
670         $finalgrade = '0';
671     }
672     $param['quizid'] = $quiz->id;
673     $param['quizid2'] = $quiz->id;
674     $param['quizid3'] = $quiz->id;
675     $param['quizid4'] = $quiz->id;
676     $param['statefinished'] = quiz_attempt::FINISHED;
677     $param['statefinished2'] = quiz_attempt::FINISHED;
678     $finalgradesubquery = "
679             SELECT quiza.userid, $finalgrade AS newgrade
680             FROM {quiz_attempts} quiza
681             $join
682             WHERE
683                 $where
684                 quiza.quiza.state = :statefinished AND
685                 quiza.preview = 0 AND
686                 quiza.quiz = :quizid3
687             GROUP BY quiza.userid";
689     $changedgrades = $DB->get_records_sql("
690             SELECT users.userid, qg.id, qg.grade, newgrades.newgrade
692             FROM (
693                 SELECT userid
694                 FROM {quiz_grades} qg
695                 WHERE quiz = :quizid
696             UNION
697                 SELECT DISTINCT userid
698                 FROM {quiz_attempts} quiza2
699                 WHERE
700                     quiza2.quiza.state = :statefinished2 AND
701                     quiza2.preview = 0 AND
702                     quiza2.quiz = :quizid2
703             ) users
705             LEFT JOIN {quiz_grades} qg ON qg.userid = users.userid AND qg.quiz = :quizid4
707             LEFT JOIN (
708                 $finalgradesubquery
709             ) newgrades ON newgrades.userid = users.userid
711             WHERE
712                 ABS(newgrades.newgrade - qg.grade) > 0.000005 OR
713                 ((newgrades.newgrade IS NULL OR qg.grade IS NULL) AND NOT
714                           (newgrades.newgrade IS NULL AND qg.grade IS NULL))",
715                 // The mess on the previous line is detecting where the value is
716                 // NULL in one column, and NOT NULL in the other, but SQL does
717                 // not have an XOR operator, and MS SQL server can't cope with
718                 // (newgrades.newgrade IS NULL) <> (qg.grade IS NULL).
719             $param);
721     $timenow = time();
722     $todelete = array();
723     foreach ($changedgrades as $changedgrade) {
725         if (is_null($changedgrade->newgrade)) {
726             $todelete[] = $changedgrade->userid;
728         } else if (is_null($changedgrade->grade)) {
729             $toinsert = new stdClass();
730             $toinsert->quiz = $quiz->id;
731             $toinsert->userid = $changedgrade->userid;
732             $toinsert->timemodified = $timenow;
733             $toinsert->grade = $changedgrade->newgrade;
734             $DB->insert_record('quiz_grades', $toinsert);
736         } else {
737             $toupdate = new stdClass();
738             $toupdate->id = $changedgrade->id;
739             $toupdate->grade = $changedgrade->newgrade;
740             $toupdate->timemodified = $timenow;
741             $DB->update_record('quiz_grades', $toupdate);
742         }
743     }
745     if (!empty($todelete)) {
746         list($test, $params) = $DB->get_in_or_equal($todelete);
747         $DB->delete_records_select('quiz_grades', 'quiz = ? AND userid ' . $test,
748                 array_merge(array($quiz->id), $params));
749     }
752 /**
753  * Return the attempt with the best grade for a quiz
754  *
755  * Which attempt is the best depends on $quiz->grademethod. If the grade
756  * method is GRADEAVERAGE then this function simply returns the last attempt.
757  * @return object         The attempt with the best grade
758  * @param object $quiz    The quiz for which the best grade is to be calculated
759  * @param array $attempts An array of all the attempts of the user at the quiz
760  */
761 function quiz_calculate_best_attempt($quiz, $attempts) {
763     switch ($quiz->grademethod) {
765         case QUIZ_ATTEMPTFIRST:
766             foreach ($attempts as $attempt) {
767                 return $attempt;
768             }
769             break;
771         case QUIZ_GRADEAVERAGE: // need to do something with it :-)
772         case QUIZ_ATTEMPTLAST:
773             foreach ($attempts as $attempt) {
774                 $final = $attempt;
775             }
776             return $final;
778         default:
779         case QUIZ_GRADEHIGHEST:
780             $max = -1;
781             foreach ($attempts as $attempt) {
782                 if ($attempt->sumgrades > $max) {
783                     $max = $attempt->sumgrades;
784                     $maxattempt = $attempt;
785                 }
786             }
787             return $maxattempt;
788     }
791 /**
792  * @return array int => lang string the options for calculating the quiz grade
793  *      from the individual attempt grades.
794  */
795 function quiz_get_grading_options() {
796     return array(
797         QUIZ_GRADEHIGHEST => get_string('gradehighest', 'quiz'),
798         QUIZ_GRADEAVERAGE => get_string('gradeaverage', 'quiz'),
799         QUIZ_ATTEMPTFIRST => get_string('attemptfirst', 'quiz'),
800         QUIZ_ATTEMPTLAST  => get_string('attemptlast', 'quiz')
801     );
804 /**
805  * @param int $option one of the values QUIZ_GRADEHIGHEST, QUIZ_GRADEAVERAGE,
806  *      QUIZ_ATTEMPTFIRST or QUIZ_ATTEMPTLAST.
807  * @return the lang string for that option.
808  */
809 function quiz_get_grading_option_name($option) {
810     $strings = quiz_get_grading_options();
811     return $strings[$option];
814 /**
815  * @return array string => lang string the options for handling overdue quiz
816  *      attempts.
817  */
818 function quiz_get_overdue_handling_options() {
819     return array(
820         'autosubmit'  => get_string('overduehandlingautosubmit', 'quiz'),
821         'graceperiod' => get_string('overduehandlinggraceperiod', 'quiz'),
822         'autoabandon' => get_string('overduehandlingautoabandon', 'quiz'),
823     );
826 /**
827  * @param string $state one of the state constants like IN_PROGRESS.
828  * @return string the human-readable state name.
829  */
830 function quiz_attempt_state_name($state) {
831     switch ($state) {
832         case quiz_attempt::IN_PROGRESS:
833             return get_string('stateinprogress', 'quiz');
834         case quiz_attempt::OVERDUE:
835             return get_string('stateoverdue', 'quiz');
836         case quiz_attempt::FINISHED:
837             return get_string('statefinished', 'quiz');
838         case quiz_attempt::ABANDONED:
839             return get_string('stateabandoned', 'quiz');
840         default:
841             throw new coding_exception('Unknown quiz attempt state.');
842     }
845 /// Other quiz functions ////////////////////////////////////////////////////
847 /**
848  * @param object $quiz the quiz.
849  * @param int $cmid the course_module object for this quiz.
850  * @param object $question the question.
851  * @param string $returnurl url to return to after action is done.
852  * @return string html for a number of icons linked to action pages for a
853  * question - preview and edit / view icons depending on user capabilities.
854  */
855 function quiz_question_action_icons($quiz, $cmid, $question, $returnurl) {
856     $html = quiz_question_preview_button($quiz, $question) . ' ' .
857             quiz_question_edit_button($cmid, $question, $returnurl);
858     return $html;
861 /**
862  * @param int $cmid the course_module.id for this quiz.
863  * @param object $question the question.
864  * @param string $returnurl url to return to after action is done.
865  * @param string $contentbeforeicon some HTML content to be added inside the link, before the icon.
866  * @return the HTML for an edit icon, view icon, or nothing for a question
867  *      (depending on permissions).
868  */
869 function quiz_question_edit_button($cmid, $question, $returnurl, $contentaftericon = '') {
870     global $CFG, $OUTPUT;
872     // Minor efficiency saving. Only get strings once, even if there are a lot of icons on one page.
873     static $stredit = null;
874     static $strview = null;
875     if ($stredit === null) {
876         $stredit = get_string('edit');
877         $strview = get_string('view');
878     }
880     // What sort of icon should we show?
881     $action = '';
882     if (!empty($question->id) &&
883             (question_has_capability_on($question, 'edit', $question->category) ||
884                     question_has_capability_on($question, 'move', $question->category))) {
885         $action = $stredit;
886         $icon = '/t/edit';
887     } else if (!empty($question->id) &&
888             question_has_capability_on($question, 'view', $question->category)) {
889         $action = $strview;
890         $icon = '/i/info';
891     }
893     // Build the icon.
894     if ($action) {
895         if ($returnurl instanceof moodle_url) {
896             $returnurl = $returnurl->out_as_local_url(false);
897         }
898         $questionparams = array('returnurl' => $returnurl, 'cmid' => $cmid, 'id' => $question->id);
899         $questionurl = new moodle_url("$CFG->wwwroot/question/question.php", $questionparams);
900         return '<a title="' . $action . '" href="' . $questionurl->out() . '" class="questioneditbutton"><img src="' .
901                 $OUTPUT->pix_url($icon) . '" alt="' . $action . '" />' . $contentaftericon .
902                 '</a>';
903     } else if ($contentaftericon) {
904         return '<span class="questioneditbutton">' . $contentaftericon . '</span>';
905     } else {
906         return '';
907     }
910 /**
911  * @param object $quiz the quiz settings
912  * @param object $question the question
913  * @return moodle_url to preview this question with the options from this quiz.
914  */
915 function quiz_question_preview_url($quiz, $question) {
916     // Get the appropriate display options.
917     $displayoptions = mod_quiz_display_options::make_from_quiz($quiz,
918             mod_quiz_display_options::DURING);
920     $maxmark = null;
921     if (isset($question->maxmark)) {
922         $maxmark = $question->maxmark;
923     }
925     // Work out the correcte preview URL.
926     return question_preview_url($question->id, $quiz->preferredbehaviour,
927             $maxmark, $displayoptions);
930 /**
931  * @param object $quiz the quiz settings
932  * @param object $question the question
933  * @param bool $label if true, show the preview question label after the icon
934  * @return the HTML for a preview question icon.
935  */
936 function quiz_question_preview_button($quiz, $question, $label = false) {
937     global $CFG, $OUTPUT;
938     if (!question_has_capability_on($question, 'use', $question->category)) {
939         return '';
940     }
942     $url = quiz_question_preview_url($quiz, $question);
944     // Do we want a label?
945     $strpreviewlabel = '';
946     if ($label) {
947         $strpreviewlabel = get_string('preview', 'quiz');
948     }
950     // Build the icon.
951     $strpreviewquestion = get_string('previewquestion', 'quiz');
952     $image = $OUTPUT->pix_icon('t/preview', $strpreviewquestion);
954     $action = new popup_action('click', $url, 'questionpreview',
955             question_preview_popup_params());
957     return $OUTPUT->action_link($url, $image, $action, array('title' => $strpreviewquestion));
960 /**
961  * @param object $attempt the attempt.
962  * @param object $context the quiz context.
963  * @return int whether flags should be shown/editable to the current user for this attempt.
964  */
965 function quiz_get_flag_option($attempt, $context) {
966     global $USER;
967     if (!has_capability('moodle/question:flag', $context)) {
968         return question_display_options::HIDDEN;
969     } else if ($attempt->userid == $USER->id) {
970         return question_display_options::EDITABLE;
971     } else {
972         return question_display_options::VISIBLE;
973     }
976 /**
977  * Work out what state this quiz attempt is in - in the sense used by
978  * quiz_get_review_options, not in the sense of $attempt->state.
979  * @param object $quiz the quiz settings
980  * @param object $attempt the quiz_attempt database row.
981  * @return int one of the mod_quiz_display_options::DURING,
982  *      IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
983  */
984 function quiz_attempt_state($quiz, $attempt) {
985     if ($attempt->state != quiz_attempt::FINISHED) {
986         return mod_quiz_display_options::DURING;
987     } else if (time() < $attempt->timefinish + 120) {
988         return mod_quiz_display_options::IMMEDIATELY_AFTER;
989     } else if (!$quiz->timeclose || time() < $quiz->timeclose) {
990         return mod_quiz_display_options::LATER_WHILE_OPEN;
991     } else {
992         return mod_quiz_display_options::AFTER_CLOSE;
993     }
996 /**
997  * The the appropraite mod_quiz_display_options object for this attempt at this
998  * quiz right now.
999  *
1000  * @param object $quiz the quiz instance.
1001  * @param object $attempt the attempt in question.
1002  * @param $context the quiz context.
1003  *
1004  * @return mod_quiz_display_options
1005  */
1006 function quiz_get_review_options($quiz, $attempt, $context) {
1007     $options = mod_quiz_display_options::make_from_quiz($quiz, quiz_attempt_state($quiz, $attempt));
1009     $options->readonly = true;
1010     $options->flags = quiz_get_flag_option($attempt, $context);
1011     if (!empty($attempt->id)) {
1012         $options->questionreviewlink = new moodle_url('/mod/quiz/reviewquestion.php',
1013                 array('attempt' => $attempt->id));
1014     }
1016     // Show a link to the comment box only for closed attempts
1017     if (!empty($attempt->id) && $attempt->state == quiz_attempt::FINISHED && !$attempt->preview &&
1018             !is_null($context) && has_capability('mod/quiz:grade', $context)) {
1019         $options->manualcomment = question_display_options::VISIBLE;
1020         $options->manualcommentlink = new moodle_url('/mod/quiz/comment.php',
1021                 array('attempt' => $attempt->id));
1022     }
1024     if (!is_null($context) && !$attempt->preview &&
1025             has_capability('mod/quiz:viewreports', $context) &&
1026             has_capability('moodle/grade:viewhidden', $context)) {
1027         // People who can see reports and hidden grades should be shown everything,
1028         // except during preview when teachers want to see what students see.
1029         $options->attempt = question_display_options::VISIBLE;
1030         $options->correctness = question_display_options::VISIBLE;
1031         $options->marks = question_display_options::MARK_AND_MAX;
1032         $options->feedback = question_display_options::VISIBLE;
1033         $options->numpartscorrect = question_display_options::VISIBLE;
1034         $options->generalfeedback = question_display_options::VISIBLE;
1035         $options->rightanswer = question_display_options::VISIBLE;
1036         $options->overallfeedback = question_display_options::VISIBLE;
1037         $options->history = question_display_options::VISIBLE;
1039     }
1041     return $options;
1044 /**
1045  * Combines the review options from a number of different quiz attempts.
1046  * Returns an array of two ojects, so the suggested way of calling this
1047  * funciton is:
1048  * list($someoptions, $alloptions) = quiz_get_combined_reviewoptions(...)
1049  *
1050  * @param object $quiz the quiz instance.
1051  * @param array $attempts an array of attempt objects.
1052  * @param $context the roles and permissions context,
1053  *          normally the context for the quiz module instance.
1054  *
1055  * @return array of two options objects, one showing which options are true for
1056  *          at least one of the attempts, the other showing which options are true
1057  *          for all attempts.
1058  */
1059 function quiz_get_combined_reviewoptions($quiz, $attempts) {
1060     $fields = array('feedback', 'generalfeedback', 'rightanswer', 'overallfeedback');
1061     $someoptions = new stdClass();
1062     $alloptions = new stdClass();
1063     foreach ($fields as $field) {
1064         $someoptions->$field = false;
1065         $alloptions->$field = true;
1066     }
1067     $someoptions->marks = question_display_options::HIDDEN;
1068     $alloptions->marks = question_display_options::MARK_AND_MAX;
1070     foreach ($attempts as $attempt) {
1071         $attemptoptions = mod_quiz_display_options::make_from_quiz($quiz,
1072                 quiz_attempt_state($quiz, $attempt));
1073         foreach ($fields as $field) {
1074             $someoptions->$field = $someoptions->$field || $attemptoptions->$field;
1075             $alloptions->$field = $alloptions->$field && $attemptoptions->$field;
1076         }
1077         $someoptions->marks = max($someoptions->marks, $attemptoptions->marks);
1078         $alloptions->marks = min($alloptions->marks, $attemptoptions->marks);
1079     }
1080     return array($someoptions, $alloptions);
1083 /**
1084  * Clean the question layout from various possible anomalies:
1085  * - Remove consecutive ","'s
1086  * - Remove duplicate question id's
1087  * - Remove extra "," from beginning and end
1088  * - Finally, add a ",0" in the end if there is none
1089  *
1090  * @param $string $layout the quiz layout to clean up, usually from $quiz->questions.
1091  * @param bool $removeemptypages If true, remove empty pages from the quiz. False by default.
1092  * @return $string the cleaned-up layout
1093  */
1094 function quiz_clean_layout($layout, $removeemptypages = false) {
1095     // Remove repeated ','s. This can happen when a restore fails to find the right
1096     // id to relink to.
1097     $layout = preg_replace('/,{2,}/', ',', trim($layout, ','));
1099     // Remove duplicate question ids
1100     $layout = explode(',', $layout);
1101     $cleanerlayout = array();
1102     $seen = array();
1103     foreach ($layout as $item) {
1104         if ($item == 0) {
1105             $cleanerlayout[] = '0';
1106         } else if (!in_array($item, $seen)) {
1107             $cleanerlayout[] = $item;
1108             $seen[] = $item;
1109         }
1110     }
1112     if ($removeemptypages) {
1113         // Avoid duplicate page breaks
1114         $layout = $cleanerlayout;
1115         $cleanerlayout = array();
1116         $stripfollowingbreaks = true; // Ensure breaks are stripped from the start.
1117         foreach ($layout as $item) {
1118             if ($stripfollowingbreaks && $item == 0) {
1119                 continue;
1120             }
1121             $cleanerlayout[] = $item;
1122             $stripfollowingbreaks = $item == 0;
1123         }
1124     }
1126     // Add a page break at the end if there is none
1127     if (end($cleanerlayout) !== '0') {
1128         $cleanerlayout[] = '0';
1129     }
1131     return implode(',', $cleanerlayout);
1134 /**
1135  * Get the slot for a question with a particular id.
1136  * @param object $quiz the quiz settings.
1137  * @param int $questionid the of a question in the quiz.
1138  * @return int the corresponding slot. Null if the question is not in the quiz.
1139  */
1140 function quiz_get_slot_for_question($quiz, $questionid) {
1141     $questionids = quiz_questions_in_quiz($quiz->questions);
1142     foreach (explode(',', $questionids) as $key => $id) {
1143         if ($id == $questionid) {
1144             return $key + 1;
1145         }
1146     }
1147     return null;
1150 /// FUNCTIONS FOR SENDING NOTIFICATION MESSAGES ///////////////////////////////
1152 /**
1153  * Sends a confirmation message to the student confirming that the attempt was processed.
1154  *
1155  * @param object $a lots of useful information that can be used in the message
1156  *      subject and body.
1157  *
1158  * @return int|false as for {@link message_send()}.
1159  */
1160 function quiz_send_confirmation($recipient, $a) {
1162     // Add information about the recipient to $a
1163     // Don't do idnumber. we want idnumber to be the submitter's idnumber.
1164     $a->username     = fullname($recipient);
1165     $a->userusername = $recipient->username;
1167     // Prepare message
1168     $eventdata = new stdClass();
1169     $eventdata->component         = 'mod_quiz';
1170     $eventdata->name              = 'confirmation';
1171     $eventdata->notification      = 1;
1173     $eventdata->userfrom          = get_admin();
1174     $eventdata->userto            = $recipient;
1175     $eventdata->subject           = get_string('emailconfirmsubject', 'quiz', $a);
1176     $eventdata->fullmessage       = get_string('emailconfirmbody', 'quiz', $a);
1177     $eventdata->fullmessageformat = FORMAT_PLAIN;
1178     $eventdata->fullmessagehtml   = '';
1180     $eventdata->smallmessage      = get_string('emailconfirmsmall', 'quiz', $a);
1181     $eventdata->contexturl        = $a->quizurl;
1182     $eventdata->contexturlname    = $a->quizname;
1184     // ... and send it.
1185     return message_send($eventdata);
1188 /**
1189  * Sends notification messages to the interested parties that assign the role capability
1190  *
1191  * @param object $recipient user object of the intended recipient
1192  * @param object $a associative array of replaceable fields for the templates
1193  *
1194  * @return int|false as for {@link message_send()}.
1195  */
1196 function quiz_send_notification($recipient, $submitter, $a) {
1198     // Recipient info for template
1199     $a->useridnumber = $recipient->idnumber;
1200     $a->username     = fullname($recipient);
1201     $a->userusername = $recipient->username;
1203     // Prepare message
1204     $eventdata = new stdClass();
1205     $eventdata->component         = 'mod_quiz';
1206     $eventdata->name              = 'submission';
1207     $eventdata->notification      = 1;
1209     $eventdata->userfrom          = $submitter;
1210     $eventdata->userto            = $recipient;
1211     $eventdata->subject           = get_string('emailnotifysubject', 'quiz', $a);
1212     $eventdata->fullmessage       = get_string('emailnotifybody', 'quiz', $a);
1213     $eventdata->fullmessageformat = FORMAT_PLAIN;
1214     $eventdata->fullmessagehtml   = '';
1216     $eventdata->smallmessage      = get_string('emailnotifysmall', 'quiz', $a);
1217     $eventdata->contexturl        = $a->quizreviewurl;
1218     $eventdata->contexturlname    = $a->quizname;
1220     // ... and send it.
1221     return message_send($eventdata);
1224 /**
1225  * Send all the requried messages when a quiz attempt is submitted.
1226  *
1227  * @param object $course the course
1228  * @param object $quiz the quiz
1229  * @param object $attempt this attempt just finished
1230  * @param object $context the quiz context
1231  * @param object $cm the coursemodule for this quiz
1232  *
1233  * @return bool true if all necessary messages were sent successfully, else false.
1234  */
1235 function quiz_send_notification_messages($course, $quiz, $attempt, $context, $cm) {
1236     global $CFG, $DB;
1238     // Do nothing if required objects not present
1239     if (empty($course) or empty($quiz) or empty($attempt) or empty($context)) {
1240         throw new coding_exception('$course, $quiz, $attempt, $context and $cm must all be set.');
1241     }
1243     $submitter = $DB->get_record('user', array('id' => $attempt->userid), '*', MUST_EXIST);
1245     // Check for confirmation required
1246     $sendconfirm = false;
1247     $notifyexcludeusers = '';
1248     if (has_capability('mod/quiz:emailconfirmsubmission', $context, $submitter, false)) {
1249         $notifyexcludeusers = $submitter->id;
1250         $sendconfirm = true;
1251     }
1253     // check for notifications required
1254     $notifyfields = 'u.id, u.username, u.firstname, u.lastname, u.idnumber, u.email, u.emailstop, ' .
1255             'u.lang, u.timezone, u.mailformat, u.maildisplay';
1256     $groups = groups_get_all_groups($course->id, $submitter->id);
1257     if (is_array($groups) && count($groups) > 0) {
1258         $groups = array_keys($groups);
1259     } else if (groups_get_activity_groupmode($cm, $course) != NOGROUPS) {
1260         // If the user is not in a group, and the quiz is set to group mode,
1261         // then set $groups to a non-existant id so that only users with
1262         // 'moodle/site:accessallgroups' get notified.
1263         $groups = -1;
1264     } else {
1265         $groups = '';
1266     }
1267     $userstonotify = get_users_by_capability($context, 'mod/quiz:emailnotifysubmission',
1268             $notifyfields, '', '', '', $groups, $notifyexcludeusers, false, false, true);
1270     if (empty($userstonotify) && !$sendconfirm) {
1271         return true; // Nothing to do.
1272     }
1274     $a = new stdClass();
1275     // Course info
1276     $a->coursename      = $course->fullname;
1277     $a->courseshortname = $course->shortname;
1278     // Quiz info
1279     $a->quizname        = $quiz->name;
1280     $a->quizreporturl   = $CFG->wwwroot . '/mod/quiz/report.php?id=' . $cm->id;
1281     $a->quizreportlink  = '<a href="' . $a->quizreporturl . '">' .
1282             format_string($quiz->name) . ' report</a>';
1283     $a->quizurl         = $CFG->wwwroot . '/mod/quiz/view.php?id=' . $cm->id;
1284     $a->quizlink        = '<a href="' . $a->quizurl . '">' . format_string($quiz->name) . '</a>';
1285     // Attempt info
1286     $a->submissiontime  = userdate($attempt->timefinish);
1287     $a->timetaken       = format_time($attempt->timefinish - $attempt->timestart);
1288     $a->quizreviewurl   = $CFG->wwwroot . '/mod/quiz/review.php?attempt=' . $attempt->id;
1289     $a->quizreviewlink  = '<a href="' . $a->quizreviewurl . '">' .
1290             format_string($quiz->name) . ' review</a>';
1291     // Student who sat the quiz info
1292     $a->studentidnumber = $submitter->idnumber;
1293     $a->studentname     = fullname($submitter);
1294     $a->studentusername = $submitter->username;
1296     $allok = true;
1298     // Send notifications if required
1299     if (!empty($userstonotify)) {
1300         foreach ($userstonotify as $recipient) {
1301             $allok = $allok && quiz_send_notification($recipient, $submitter, $a);
1302         }
1303     }
1305     // Send confirmation if required. We send the student confirmation last, so
1306     // that if message sending is being intermittently buggy, which means we send
1307     // some but not all messages, and then try again later, then teachers may get
1308     // duplicate messages, but the student will always get exactly one.
1309     if ($sendconfirm) {
1310         $allok = $allok && quiz_send_confirmation($submitter, $a);
1311     }
1313     return $allok;
1316 /**
1317  * Send the notification message when a quiz attempt becomes overdue.
1318  *
1319  * @param object $course the course
1320  * @param object $quiz the quiz
1321  * @param object $attempt this attempt just finished
1322  * @param object $context the quiz context
1323  * @param object $cm the coursemodule for this quiz
1324  */
1325 function quiz_send_overdue_message($course, $quiz, $attempt, $context, $cm) {
1326     global $CFG, $DB;
1328     // Do nothing if required objects not present
1329     if (empty($course) or empty($quiz) or empty($attempt) or empty($context)) {
1330         throw new coding_exception('$course, $quiz, $attempt, $context and $cm must all be set.');
1331     }
1333     $submitter = $DB->get_record('user', array('id' => $attempt->userid), '*', MUST_EXIST);
1335     if (!has_capability('mod/quiz:emailwarnoverdue', $context, $submitter, false)) {
1336         return; // Message not required.
1337     }
1339     // Prepare lots of useful information that admins might want to include in
1340     // the email message.
1341     $quizname = format_string($quiz->name);
1343     $deadlines = array();
1344     if ($quiz->timelimit) {
1345         $deadlines[] = $attempt->timestart + $quiz->timelimit;
1346     }
1347     if ($quiz->timeclose) {
1348         $deadlines[] = $quiz->timeclose;
1349     }
1350     $duedate = min($deadlines) + $quiz->graceperiod;
1352     $a = new stdClass();
1353     // Course info.
1354     $a->coursename         = $course->fullname;
1355     $a->courseshortname    = $course->shortname;
1356     // Quiz info.
1357     $a->quizname           = $quizname;
1358     $a->quizurl            = $CFG->wwwroot . '/mod/quiz/view.php?id=' . $cm->id;
1359     $a->quizlink           = '<a href="' . $a->quizurl . '">' . $quizname . '</a>';
1360     // Attempt info.
1361     $a->attemptgraceend    = format_time($duedate);
1362     $a->attemptsummaryurl  = $CFG->wwwroot . '/mod/quiz/summary.php?attempt=' . $attempt->id;
1363     $a->attemptsummarylink = '<a href="' . $a->attemptsummaryurl . '">' . $quizname . ' review</a>';
1364     // Student's info.
1365     $a->studentidnumber    = $submitter->idnumber;
1366     $a->studentname        = fullname($submitter);
1367     $a->studentusername    = $submitter->username;
1369     // Prepare the message.
1370     $eventdata = new stdClass();
1371     $eventdata->component         = 'mod_quiz';
1372     $eventdata->name              = 'attempt_overdue';
1373     $eventdata->notification      = 1;
1375     $eventdata->userfrom          = get_admin();
1376     $eventdata->userto            = $submitter;
1377     $eventdata->subject           = get_string('emailoverduesubject', 'quiz', $a);
1378     $eventdata->fullmessage       = get_string('emailoverduebody', 'quiz', $a);
1379     $eventdata->fullmessageformat = FORMAT_PLAIN;
1380     $eventdata->fullmessagehtml   = '';
1382     $eventdata->smallmessage      = get_string('emailoverduesmall', 'quiz', $a);
1383     $eventdata->contexturl        = $a->quizurl;
1384     $eventdata->contexturlname    = $a->quizname;
1386     // Send the message.
1387     return message_send($eventdata);
1390 /**
1391  * Handle the quiz_attempt_submitted event.
1392  *
1393  * This sends the confirmation and notification messages, if required.
1394  *
1395  * @param object $event the event object.
1396  */
1397 function quiz_attempt_submitted_handler($event) {
1398     global $DB;
1400     $course  = $DB->get_record('course', array('id' => $event->courseid));
1401     $quiz    = $DB->get_record('quiz', array('id' => $event->quizid));
1402     $cm      = get_coursemodule_from_id('quiz', $event->cmid, $event->courseid);
1403     $attempt = $DB->get_record('quiz_attempts', array('id' => $event->attemptid));
1405     if (!($course && $quiz && $cm && $attempt)) {
1406         // Something has been deleted since the event was raised. Therefore, the
1407         // event is no longer relevant.
1408         return true;
1409     }
1411     return quiz_send_notification_messages($course, $quiz, $attempt,
1412             get_context_instance(CONTEXT_MODULE, $cm->id), $cm);
1415 /**
1416  * Handle the quiz_attempt_overdue event.
1417  *
1418  * For quizzes with applicable settings, this sends a message to the user, reminding
1419  * them that they forgot to submit, and that they have another chance to do so.
1420  *
1421  * @param object $event the event object.
1422  */
1423 function quiz_attempt_overdue_handler($event) {
1424     global $DB;
1426     $course  = $DB->get_record('course', array('id' => $event->courseid));
1427     $quiz    = $DB->get_record('quiz', array('id' => $event->quizid));
1428     $cm      = get_coursemodule_from_id('quiz', $event->cmid, $event->courseid);
1429     $attempt = $DB->get_record('quiz_attempts', array('id' => $event->attemptid));
1431     if (!($course && $quiz && $cm && $attempt)) {
1432         // Something has been deleted since the event was raised. Therefore, the
1433         // event is no longer relevant.
1434         return true;
1435     }
1437     return quiz_send_overdue_message($course, $quiz, $attempt,
1438             get_context_instance(CONTEXT_MODULE, $cm->id), $cm);
1441 /**
1442  * Get the information about the standard quiz JavaScript module.
1443  * @return array a standard jsmodule structure.
1444  */
1445 function quiz_get_js_module() {
1446     global $PAGE;
1448     return array(
1449         'name' => 'mod_quiz',
1450         'fullpath' => '/mod/quiz/module.js',
1451         'requires' => array('base', 'dom', 'event-delegate', 'event-key',
1452                 'core_question_engine'),
1453         'strings' => array(
1454             array('cancel', 'moodle'),
1455             array('flagged', 'question'),
1456             array('functiondisabledbysecuremode', 'quiz'),
1457             array('startattempt', 'quiz'),
1458             array('timesup', 'quiz'),
1459         ),
1460     );
1464 /**
1465  * An extension of question_display_options that includes the extra options used
1466  * by the quiz.
1467  *
1468  * @copyright  2010 The Open University
1469  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1470  */
1471 class mod_quiz_display_options extends question_display_options {
1472     /**#@+
1473      * @var integer bits used to indicate various times in relation to a
1474      * quiz attempt.
1475      */
1476     const DURING =            0x10000;
1477     const IMMEDIATELY_AFTER = 0x01000;
1478     const LATER_WHILE_OPEN =  0x00100;
1479     const AFTER_CLOSE =       0x00010;
1480     /**#@-*/
1482     /**
1483      * @var boolean if this is false, then the student is not allowed to review
1484      * anything about the attempt.
1485      */
1486     public $attempt = true;
1488     /**
1489      * @var boolean if this is false, then the student is not allowed to review
1490      * anything about the attempt.
1491      */
1492     public $overallfeedback = self::VISIBLE;
1494     /**
1495      * Set up the various options from the quiz settings, and a time constant.
1496      * @param object $quiz the quiz settings.
1497      * @param int $one of the {@link DURING}, {@link IMMEDIATELY_AFTER},
1498      * {@link LATER_WHILE_OPEN} or {@link AFTER_CLOSE} constants.
1499      * @return mod_quiz_display_options set up appropriately.
1500      */
1501     public static function make_from_quiz($quiz, $when) {
1502         $options = new self();
1504         $options->attempt = self::extract($quiz->reviewattempt, $when, true, false);
1505         $options->correctness = self::extract($quiz->reviewcorrectness, $when);
1506         $options->marks = self::extract($quiz->reviewmarks, $when,
1507                 self::MARK_AND_MAX, self::MAX_ONLY);
1508         $options->feedback = self::extract($quiz->reviewspecificfeedback, $when);
1509         $options->generalfeedback = self::extract($quiz->reviewgeneralfeedback, $when);
1510         $options->rightanswer = self::extract($quiz->reviewrightanswer, $when);
1511         $options->overallfeedback = self::extract($quiz->reviewoverallfeedback, $when);
1513         $options->numpartscorrect = $options->feedback;
1515         if ($quiz->questiondecimalpoints != -1) {
1516             $options->markdp = $quiz->questiondecimalpoints;
1517         } else {
1518             $options->markdp = $quiz->decimalpoints;
1519         }
1521         return $options;
1522     }
1524     protected static function extract($bitmask, $bit,
1525             $whenset = self::VISIBLE, $whennotset = self::HIDDEN) {
1526         if ($bitmask & $bit) {
1527             return $whenset;
1528         } else {
1529             return $whennotset;
1530         }
1531     }
1535 /**
1536  * A {@link qubaid_condition} for finding all the question usages belonging to
1537  * a particular quiz.
1538  *
1539  * @copyright  2010 The Open University
1540  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1541  */
1542 class qubaids_for_quiz extends qubaid_join {
1543     public function __construct($quizid, $includepreviews = true, $onlyfinished = false) {
1544         $where = 'quiza.quiz = :quizaquiz';
1545         $params = array('quizaquiz' => $quizid);
1547         if (!$includepreviews) {
1548             $where .= ' AND preview = 0';
1549         }
1551         if ($onlyfinished) {
1552             $where .= ' AND state == :statefinished';
1553             $params['statefinished'] = quiz_attempt::FINISHED;
1554         }
1556         parent::__construct('{quiz_attempts} quiza', 'quiza.uniqueid', $where, $params);
1557     }