Merge branch 'MDL-31080' of git://github.com/timhunt/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 /// Functions related to attempts /////////////////////////////////////////
53 /**
54  * Creates an object to represent a new attempt at a quiz
55  *
56  * Creates an attempt object to represent an attempt at the quiz by the current
57  * user starting at the current time. The ->id field is not set. The object is
58  * NOT written to the database.
59  *
60  * @param object $quiz the quiz to create an attempt for.
61  * @param int $attemptnumber the sequence number for the attempt.
62  * @param object $lastattempt the previous attempt by this user, if any. Only needed
63  *         if $attemptnumber > 1 and $quiz->attemptonlast is true.
64  * @param int $timenow the time the attempt was started at.
65  * @param bool $ispreview whether this new attempt is a preview.
66  *
67  * @return object the newly created attempt object.
68  */
69 function quiz_create_attempt($quiz, $attemptnumber, $lastattempt, $timenow, $ispreview = false) {
70     global $USER;
72     if ($quiz->sumgrades < 0.000005 && $quiz->grade > 0.000005) {
73         throw new moodle_exception('cannotstartgradesmismatch', 'quiz',
74                 new moodle_url('/mod/quiz/view.php', array('q' => $quiz->id)));
75     }
77     if ($attemptnumber == 1 || !$quiz->attemptonlast) {
78         // We are not building on last attempt so create a new attempt.
79         $attempt = new stdClass();
80         $attempt->quiz = $quiz->id;
81         $attempt->userid = $USER->id;
82         $attempt->preview = 0;
83         $attempt->layout = quiz_clean_layout($quiz->questions, true);
84         if ($quiz->shufflequestions) {
85             $attempt->layout = quiz_repaginate($attempt->layout, $quiz->questionsperpage, true);
86         }
87     } else {
88         // Build on last attempt.
89         if (empty($lastattempt)) {
90             print_error('cannotfindprevattempt', 'quiz');
91         }
92         $attempt = $lastattempt;
93     }
95     $attempt->attempt = $attemptnumber;
96     $attempt->timestart = $timenow;
97     $attempt->timefinish = 0;
98     $attempt->timemodified = $timenow;
100     // If this is a preview, mark it as such.
101     if ($ispreview) {
102         $attempt->preview = 1;
103     }
105     return $attempt;
108 /**
109  * Returns an unfinished attempt (if there is one) for the given
110  * user on the given quiz. This function does not return preview attempts.
111  *
112  * @param int $quizid the id of the quiz.
113  * @param int $userid the id of the user.
114  *
115  * @return mixed the unfinished attempt if there is one, false if not.
116  */
117 function quiz_get_user_attempt_unfinished($quizid, $userid) {
118     $attempts = quiz_get_user_attempts($quizid, $userid, 'unfinished', true);
119     if ($attempts) {
120         return array_shift($attempts);
121     } else {
122         return false;
123     }
126 /**
127  * Delete a quiz attempt.
128  * @param mixed $attempt an integer attempt id or an attempt object
129  *      (row of the quiz_attempts table).
130  * @param object $quiz the quiz object.
131  */
132 function quiz_delete_attempt($attempt, $quiz) {
133     global $DB;
134     if (is_numeric($attempt)) {
135         if (!$attempt = $DB->get_record('quiz_attempts', array('id' => $attempt))) {
136             return;
137         }
138     }
140     if ($attempt->quiz != $quiz->id) {
141         debugging("Trying to delete attempt $attempt->id which belongs to quiz $attempt->quiz " .
142                 "but was passed quiz $quiz->id.");
143         return;
144     }
146     question_engine::delete_questions_usage_by_activity($attempt->uniqueid);
147     $DB->delete_records('quiz_attempts', array('id' => $attempt->id));
149     // Search quiz_attempts for other instances by this user.
150     // If none, then delete record for this quiz, this user from quiz_grades
151     // else recalculate best grade
152     $userid = $attempt->userid;
153     if (!$DB->record_exists('quiz_attempts', array('userid' => $userid, 'quiz' => $quiz->id))) {
154         $DB->delete_records('quiz_grades', array('userid' => $userid, 'quiz' => $quiz->id));
155     } else {
156         quiz_save_best_grade($quiz, $userid);
157     }
159     quiz_update_grades($quiz, $userid);
162 /**
163  * Delete all the preview attempts at a quiz, or possibly all the attempts belonging
164  * to one user.
165  * @param object $quiz the quiz object.
166  * @param int $userid (optional) if given, only delete the previews belonging to this user.
167  */
168 function quiz_delete_previews($quiz, $userid = null) {
169     global $DB;
170     $conditions = array('quiz' => $quiz->id, 'preview' => 1);
171     if (!empty($userid)) {
172         $conditions['userid'] = $userid;
173     }
174     $previewattempts = $DB->get_records('quiz_attempts', $conditions);
175     foreach ($previewattempts as $attempt) {
176         quiz_delete_attempt($attempt, $quiz);
177     }
180 /**
181  * @param int $quizid The quiz id.
182  * @return bool whether this quiz has any (non-preview) attempts.
183  */
184 function quiz_has_attempts($quizid) {
185     global $DB;
186     return $DB->record_exists('quiz_attempts', array('quiz' => $quizid, 'preview' => 0));
189 /// Functions to do with quiz layout and pages ////////////////////////////////
191 /**
192  * Returns a comma separated list of question ids for the quiz
193  *
194  * @param string $layout The string representing the quiz layout. Each page is
195  *      represented as a comma separated list of question ids and 0 indicating
196  *      page breaks. So 5,2,0,3,0 means questions 5 and 2 on page 1 and question
197  *      3 on page 2
198  * @return string comma separated list of question ids, without page breaks.
199  */
200 function quiz_questions_in_quiz($layout) {
201     $questions = str_replace(',0', '', quiz_clean_layout($layout, true));
202     if ($questions === '0') {
203         return '';
204     } else {
205         return $questions;
206     }
209 /**
210  * Returns the number of pages in a quiz layout
211  *
212  * @param string $layout The string representing the quiz layout. Always ends in ,0
213  * @return int The number of pages in the quiz.
214  */
215 function quiz_number_of_pages($layout) {
216     return substr_count(',' . $layout, ',0');
219 /**
220  * Returns the number of questions in the quiz layout
221  *
222  * @param string $layout the string representing the quiz layout.
223  * @return int The number of questions in the quiz.
224  */
225 function quiz_number_of_questions_in_quiz($layout) {
226     $layout = quiz_questions_in_quiz(quiz_clean_layout($layout));
227     $count = substr_count($layout, ',');
228     if ($layout !== '') {
229         $count++;
230     }
231     return $count;
234 /**
235  * Re-paginates the quiz layout
236  *
237  * @param string $layout  The string representing the quiz layout. If there is
238  *      if there is any doubt about the quality of the input data, call
239  *      quiz_clean_layout before you call this function.
240  * @param int $perpage The number of questions per page
241  * @param bool $shuffle Should the questions be reordered randomly?
242  * @return string the new layout string
243  */
244 function quiz_repaginate($layout, $perpage, $shuffle = false) {
245     $questions = quiz_questions_in_quiz($layout);
246     if (!$questions) {
247         return '0';
248     }
250     $questions = explode(',', quiz_questions_in_quiz($layout));
251     if ($shuffle) {
252         shuffle($questions);
253     }
255     $onthispage = 0;
256     $layout = array();
257     foreach ($questions as $question) {
258         if ($perpage and $onthispage >= $perpage) {
259             $layout[] = 0;
260             $onthispage = 0;
261         }
262         $layout[] = $question;
263         $onthispage += 1;
264     }
266     $layout[] = 0;
267     return implode(',', $layout);
270 /// Functions to do with quiz grades //////////////////////////////////////////
272 /**
273  * Creates an array of maximum grades for a quiz
274  *
275  * The grades are extracted from the quiz_question_instances table.
276  * @param object $quiz The quiz settings.
277  * @return array of grades indexed by question id. These are the maximum
278  *      possible grades that students can achieve for each of the questions.
279  */
280 function quiz_get_all_question_grades($quiz) {
281     global $CFG, $DB;
283     $questionlist = quiz_questions_in_quiz($quiz->questions);
284     if (empty($questionlist)) {
285         return array();
286     }
288     $params = array($quiz->id);
289     $wheresql = '';
290     if (!is_null($questionlist)) {
291         list($usql, $question_params) = $DB->get_in_or_equal(explode(',', $questionlist));
292         $wheresql = " AND question $usql ";
293         $params = array_merge($params, $question_params);
294     }
296     $instances = $DB->get_records_sql("SELECT question, grade, id
297                                     FROM {quiz_question_instances}
298                                     WHERE quiz = ? $wheresql", $params);
300     $list = explode(",", $questionlist);
301     $grades = array();
303     foreach ($list as $qid) {
304         if (isset($instances[$qid])) {
305             $grades[$qid] = $instances[$qid]->grade;
306         } else {
307             $grades[$qid] = 1;
308         }
309     }
310     return $grades;
313 /**
314  * Convert the raw grade stored in $attempt into a grade out of the maximum
315  * grade for this quiz.
316  *
317  * @param float $rawgrade the unadjusted grade, fof example $attempt->sumgrades
318  * @param object $quiz the quiz object. Only the fields grade, sumgrades and decimalpoints are used.
319  * @param bool|string $format whether to format the results for display
320  *      or 'question' to format a question grade (different number of decimal places.
321  * @return float|string the rescaled grade, or null/the lang string 'notyetgraded'
322  *      if the $grade is null.
323  */
324 function quiz_rescale_grade($rawgrade, $quiz, $format = true) {
325     if (is_null($rawgrade)) {
326         $grade = null;
327     } else if ($quiz->sumgrades >= 0.000005) {
328         $grade = $rawgrade * $quiz->grade / $quiz->sumgrades;
329     } else {
330         $grade = 0;
331     }
332     if ($format === 'question') {
333         $grade = quiz_format_question_grade($quiz, $grade);
334     } else if ($format) {
335         $grade = quiz_format_grade($quiz, $grade);
336     }
337     return $grade;
340 /**
341  * Get the feedback text that should be show to a student who
342  * got this grade on this quiz. The feedback is processed ready for diplay.
343  *
344  * @param float $grade a grade on this quiz.
345  * @param object $quiz the quiz settings.
346  * @param object $context the quiz context.
347  * @return string the comment that corresponds to this grade (empty string if there is not one.
348  */
349 function quiz_feedback_for_grade($grade, $quiz, $context) {
350     global $DB;
352     if (is_null($grade)) {
353         return '';
354     }
356     $feedback = $DB->get_record_select('quiz_feedback',
357             'quizid = ? AND mingrade <= ? AND ? < maxgrade', array($quiz->id, $grade, $grade));
359     if (empty($feedback->feedbacktext)) {
360         return '';
361     }
363     // Clean the text, ready for display.
364     $formatoptions = new stdClass();
365     $formatoptions->noclean = true;
366     $feedbacktext = file_rewrite_pluginfile_urls($feedback->feedbacktext, 'pluginfile.php',
367             $context->id, 'mod_quiz', 'feedback', $feedback->id);
368     $feedbacktext = format_text($feedbacktext, $feedback->feedbacktextformat, $formatoptions);
370     return $feedbacktext;
373 /**
374  * @param object $quiz the quiz database row.
375  * @return bool Whether this quiz has any non-blank feedback text.
376  */
377 function quiz_has_feedback($quiz) {
378     global $DB;
379     static $cache = array();
380     if (!array_key_exists($quiz->id, $cache)) {
381         $cache[$quiz->id] = quiz_has_grades($quiz) &&
382                 $DB->record_exists_select('quiz_feedback', "quizid = ? AND " .
383                     $DB->sql_isnotempty('quiz_feedback', 'feedbacktext', false, true),
384                 array($quiz->id));
385     }
386     return $cache[$quiz->id];
389 /**
390  * Update the sumgrades field of the quiz. This needs to be called whenever
391  * the grading structure of the quiz is changed. For example if a question is
392  * added or removed, or a question weight is changed.
393  *
394  * You should call {@link quiz_delete_previews()} before you call this function.
395  *
396  * @param object $quiz a quiz.
397  */
398 function quiz_update_sumgrades($quiz) {
399     global $DB;
401     $sql = 'UPDATE {quiz}
402             SET sumgrades = COALESCE((
403                 SELECT SUM(grade)
404                 FROM {quiz_question_instances}
405                 WHERE quiz = {quiz}.id
406             ), 0)
407             WHERE id = ?';
408     $DB->execute($sql, array($quiz->id));
409     $quiz->sumgrades = $DB->get_field('quiz', 'sumgrades', array('id' => $quiz->id));
411     if ($quiz->sumgrades < 0.000005 && quiz_has_attempts($quiz->id)) {
412         // If the quiz has been attempted, and the sumgrades has been
413         // set to 0, then we must also set the maximum possible grade to 0, or
414         // we will get a divide by zero error.
415         quiz_set_grade(0, $quiz);
416     }
419 /**
420  * Update the sumgrades field of the attempts at a quiz.
421  *
422  * @param object $quiz a quiz.
423  */
424 function quiz_update_all_attempt_sumgrades($quiz) {
425     global $DB;
426     $dm = new question_engine_data_mapper();
427     $timenow = time();
429     $sql = "UPDATE {quiz_attempts}
430             SET
431                 timemodified = :timenow,
432                 sumgrades = (
433                     {$dm->sum_usage_marks_subquery('uniqueid')}
434                 )
435             WHERE quiz = :quizid AND timefinish <> 0";
436     $DB->execute($sql, array('timenow' => $timenow, 'quizid' => $quiz->id));
439 /**
440  * The quiz grade is the maximum that student's results are marked out of. When it
441  * changes, the corresponding data in quiz_grades and quiz_feedback needs to be
442  * rescaled. After calling this function, you probably need to call
443  * quiz_update_all_attempt_sumgrades, quiz_update_all_final_grades and
444  * quiz_update_grades.
445  *
446  * @param float $newgrade the new maximum grade for the quiz.
447  * @param object $quiz the quiz we are updating. Passed by reference so its
448  *      grade field can be updated too.
449  * @return bool indicating success or failure.
450  */
451 function quiz_set_grade($newgrade, $quiz) {
452     global $DB;
453     // This is potentially expensive, so only do it if necessary.
454     if (abs($quiz->grade - $newgrade) < 1e-7) {
455         // Nothing to do.
456         return true;
457     }
459     // Use a transaction, so that on those databases that support it, this is safer.
460     $transaction = $DB->start_delegated_transaction();
462     // Update the quiz table.
463     $DB->set_field('quiz', 'grade', $newgrade, array('id' => $quiz->instance));
465     // Rescaling the other data is only possible if the old grade was non-zero.
466     if ($quiz->grade > 1e-7) {
467         global $CFG;
469         $factor = $newgrade/$quiz->grade;
470         $quiz->grade = $newgrade;
472         // Update the quiz_grades table.
473         $timemodified = time();
474         $DB->execute("
475                 UPDATE {quiz_grades}
476                 SET grade = ? * grade, timemodified = ?
477                 WHERE quiz = ?
478         ", array($factor, $timemodified, $quiz->id));
480         // Update the quiz_feedback table.
481         $DB->execute("
482                 UPDATE {quiz_feedback}
483                 SET mingrade = ? * mingrade, maxgrade = ? * maxgrade
484                 WHERE quizid = ?
485         ", array($factor, $factor, $quiz->id));
486     }
488     // update grade item and send all grades to gradebook
489     quiz_grade_item_update($quiz);
490     quiz_update_grades($quiz);
492     $transaction->allow_commit();
493     return true;
496 /**
497  * Save the overall grade for a user at a quiz in the quiz_grades table
498  *
499  * @param object $quiz The quiz for which the best grade is to be calculated and then saved.
500  * @param int $userid The userid to calculate the grade for. Defaults to the current user.
501  * @param array $attempts The attempts of this user. Useful if you are
502  * looping through many users. Attempts can be fetched in one master query to
503  * avoid repeated querying.
504  * @return bool Indicates success or failure.
505  */
506 function quiz_save_best_grade($quiz, $userid = null, $attempts = array()) {
507     global $DB;
508     global $USER, $OUTPUT;
510     if (empty($userid)) {
511         $userid = $USER->id;
512     }
514     if (!$attempts) {
515         // Get all the attempts made by the user
516         $attempts = quiz_get_user_attempts($quiz->id, $userid);
517     }
519     // Calculate the best grade
520     $bestgrade = quiz_calculate_best_grade($quiz, $attempts);
521     $bestgrade = quiz_rescale_grade($bestgrade, $quiz, false);
523     // Save the best grade in the database
524     if (is_null($bestgrade)) {
525         $DB->delete_records('quiz_grades', array('quiz' => $quiz->id, 'userid' => $userid));
527     } else if ($grade = $DB->get_record('quiz_grades',
528             array('quiz' => $quiz->id, 'userid' => $userid))) {
529         $grade->grade = $bestgrade;
530         $grade->timemodified = time();
531         $DB->update_record('quiz_grades', $grade);
533     } else {
534         $grade->quiz = $quiz->id;
535         $grade->userid = $userid;
536         $grade->grade = $bestgrade;
537         $grade->timemodified = time();
538         $DB->insert_record('quiz_grades', $grade);
539     }
541     quiz_update_grades($quiz, $userid);
544 /**
545  * Calculate the overall grade for a quiz given a number of attempts by a particular user.
546  *
547  * @param object $quiz    the quiz settings object.
548  * @param array $attempts an array of all the user's attempts at this quiz in order.
549  * @return float          the overall grade
550  */
551 function quiz_calculate_best_grade($quiz, $attempts) {
553     switch ($quiz->grademethod) {
555         case QUIZ_ATTEMPTFIRST:
556             $firstattempt = reset($attempts);
557             return $firstattempt->sumgrades;
559         case QUIZ_ATTEMPTLAST:
560             $lastattempt = end($attempts);
561             return $lastattempt->sumgrades;
563         case QUIZ_GRADEAVERAGE:
564             $sum = 0;
565             $count = 0;
566             foreach ($attempts as $attempt) {
567                 if (!is_null($attempt->sumgrades)) {
568                     $sum += $attempt->sumgrades;
569                     $count++;
570                 }
571             }
572             if ($count == 0) {
573                 return null;
574             }
575             return $sum / $count;
577         case QUIZ_GRADEHIGHEST:
578         default:
579             $max = null;
580             foreach ($attempts as $attempt) {
581                 if ($attempt->sumgrades > $max) {
582                     $max = $attempt->sumgrades;
583                 }
584             }
585             return $max;
586     }
589 /**
590  * Update the final grade at this quiz for all students.
591  *
592  * This function is equivalent to calling quiz_save_best_grade for all
593  * users, but much more efficient.
594  *
595  * @param object $quiz the quiz settings.
596  */
597 function quiz_update_all_final_grades($quiz) {
598     global $DB;
600     if (!$quiz->sumgrades) {
601         return;
602     }
604     $param = array('iquizid' => $quiz->id);
605     $firstlastattemptjoin = "JOIN (
606             SELECT
607                 iquiza.userid,
608                 MIN(attempt) AS firstattempt,
609                 MAX(attempt) AS lastattempt
611             FROM {quiz_attempts} iquiza
613             WHERE
614                 iquiza.timefinish <> 0 AND
615                 iquiza.preview = 0 AND
616                 iquiza.quiz = :iquizid
618             GROUP BY iquiza.userid
619         ) first_last_attempts ON first_last_attempts.userid = quiza.userid";
621     switch ($quiz->grademethod) {
622         case QUIZ_ATTEMPTFIRST:
623             // Because of the where clause, there will only be one row, but we
624             // must still use an aggregate function.
625             $select = 'MAX(quiza.sumgrades)';
626             $join = $firstlastattemptjoin;
627             $where = 'quiza.attempt = first_last_attempts.firstattempt AND';
628             break;
630         case QUIZ_ATTEMPTLAST:
631             // Because of the where clause, there will only be one row, but we
632             // must still use an aggregate function.
633             $select = 'MAX(quiza.sumgrades)';
634             $join = $firstlastattemptjoin;
635             $where = 'quiza.attempt = first_last_attempts.lastattempt AND';
636             break;
638         case QUIZ_GRADEAVERAGE:
639             $select = 'AVG(quiza.sumgrades)';
640             $join = '';
641             $where = '';
642             break;
644         default:
645         case QUIZ_GRADEHIGHEST:
646             $select = 'MAX(quiza.sumgrades)';
647             $join = '';
648             $where = '';
649             break;
650     }
652     if ($quiz->sumgrades >= 0.000005) {
653         $finalgrade = $select . ' * ' . ($quiz->grade / $quiz->sumgrades);
654     } else {
655         $finalgrade = '0';
656     }
657     $param['quizid'] = $quiz->id;
658     $param['quizid2'] = $quiz->id;
659     $param['quizid3'] = $quiz->id;
660     $param['quizid4'] = $quiz->id;
661     $finalgradesubquery = "
662             SELECT quiza.userid, $finalgrade AS newgrade
663             FROM {quiz_attempts} quiza
664             $join
665             WHERE
666                 $where
667                 quiza.timefinish <> 0 AND
668                 quiza.preview = 0 AND
669                 quiza.quiz = :quizid3
670             GROUP BY quiza.userid";
672     $changedgrades = $DB->get_records_sql("
673             SELECT users.userid, qg.id, qg.grade, newgrades.newgrade
675             FROM (
676                 SELECT userid
677                 FROM {quiz_grades} qg
678                 WHERE quiz = :quizid
679             UNION
680                 SELECT DISTINCT userid
681                 FROM {quiz_attempts} quiza2
682                 WHERE
683                     quiza2.timefinish <> 0 AND
684                     quiza2.preview = 0 AND
685                     quiza2.quiz = :quizid2
686             ) users
688             LEFT JOIN {quiz_grades} qg ON qg.userid = users.userid AND qg.quiz = :quizid4
690             LEFT JOIN (
691                 $finalgradesubquery
692             ) newgrades ON newgrades.userid = users.userid
694             WHERE
695                 ABS(newgrades.newgrade - qg.grade) > 0.000005 OR
696                 ((newgrades.newgrade IS NULL OR qg.grade IS NULL) AND NOT
697                           (newgrades.newgrade IS NULL AND qg.grade IS NULL))",
698                 // The mess on the previous line is detecting where the value is
699                 // NULL in one column, and NOT NULL in the other, but SQL does
700                 // not have an XOR operator, and MS SQL server can't cope with
701                 // (newgrades.newgrade IS NULL) <> (qg.grade IS NULL).
702             $param);
704     $timenow = time();
705     $todelete = array();
706     foreach ($changedgrades as $changedgrade) {
708         if (is_null($changedgrade->newgrade)) {
709             $todelete[] = $changedgrade->userid;
711         } else if (is_null($changedgrade->grade)) {
712             $toinsert = new stdClass();
713             $toinsert->quiz = $quiz->id;
714             $toinsert->userid = $changedgrade->userid;
715             $toinsert->timemodified = $timenow;
716             $toinsert->grade = $changedgrade->newgrade;
717             $DB->insert_record('quiz_grades', $toinsert);
719         } else {
720             $toupdate = new stdClass();
721             $toupdate->id = $changedgrade->id;
722             $toupdate->grade = $changedgrade->newgrade;
723             $toupdate->timemodified = $timenow;
724             $DB->update_record('quiz_grades', $toupdate);
725         }
726     }
728     if (!empty($todelete)) {
729         list($test, $params) = $DB->get_in_or_equal($todelete);
730         $DB->delete_records_select('quiz_grades', 'quiz = ? AND userid ' . $test,
731                 array_merge(array($quiz->id), $params));
732     }
735 /**
736  * Return the attempt with the best grade for a quiz
737  *
738  * Which attempt is the best depends on $quiz->grademethod. If the grade
739  * method is GRADEAVERAGE then this function simply returns the last attempt.
740  * @return object         The attempt with the best grade
741  * @param object $quiz    The quiz for which the best grade is to be calculated
742  * @param array $attempts An array of all the attempts of the user at the quiz
743  */
744 function quiz_calculate_best_attempt($quiz, $attempts) {
746     switch ($quiz->grademethod) {
748         case QUIZ_ATTEMPTFIRST:
749             foreach ($attempts as $attempt) {
750                 return $attempt;
751             }
752             break;
754         case QUIZ_GRADEAVERAGE: // need to do something with it :-)
755         case QUIZ_ATTEMPTLAST:
756             foreach ($attempts as $attempt) {
757                 $final = $attempt;
758             }
759             return $final;
761         default:
762         case QUIZ_GRADEHIGHEST:
763             $max = -1;
764             foreach ($attempts as $attempt) {
765                 if ($attempt->sumgrades > $max) {
766                     $max = $attempt->sumgrades;
767                     $maxattempt = $attempt;
768                 }
769             }
770             return $maxattempt;
771     }
774 /**
775  * @return the options for calculating the quiz grade from the individual attempt grades.
776  */
777 function quiz_get_grading_options() {
778     return array(
779         QUIZ_GRADEHIGHEST => get_string('gradehighest', 'quiz'),
780         QUIZ_GRADEAVERAGE => get_string('gradeaverage', 'quiz'),
781         QUIZ_ATTEMPTFIRST => get_string('attemptfirst', 'quiz'),
782         QUIZ_ATTEMPTLAST  => get_string('attemptlast', 'quiz')
783     );
786 /**
787  * @param int $option one of the values QUIZ_GRADEHIGHEST, QUIZ_GRADEAVERAGE,
788  *      QUIZ_ATTEMPTFIRST or QUIZ_ATTEMPTLAST.
789  * @return the lang string for that option.
790  */
791 function quiz_get_grading_option_name($option) {
792     $strings = quiz_get_grading_options();
793     return $strings[$option];
796 /// Other quiz functions ////////////////////////////////////////////////////
798 /**
799  * @param object $quiz the quiz.
800  * @param int $cmid the course_module object for this quiz.
801  * @param object $question the question.
802  * @param string $returnurl url to return to after action is done.
803  * @return string html for a number of icons linked to action pages for a
804  * question - preview and edit / view icons depending on user capabilities.
805  */
806 function quiz_question_action_icons($quiz, $cmid, $question, $returnurl) {
807     $html = quiz_question_preview_button($quiz, $question) . ' ' .
808             quiz_question_edit_button($cmid, $question, $returnurl);
809     return $html;
812 /**
813  * @param int $cmid the course_module.id for this quiz.
814  * @param object $question the question.
815  * @param string $returnurl url to return to after action is done.
816  * @param string $contentbeforeicon some HTML content to be added inside the link, before the icon.
817  * @return the HTML for an edit icon, view icon, or nothing for a question
818  *      (depending on permissions).
819  */
820 function quiz_question_edit_button($cmid, $question, $returnurl, $contentaftericon = '') {
821     global $CFG, $OUTPUT;
823     // Minor efficiency saving. Only get strings once, even if there are a lot of icons on one page.
824     static $stredit = null;
825     static $strview = null;
826     if ($stredit === null) {
827         $stredit = get_string('edit');
828         $strview = get_string('view');
829     }
831     // What sort of icon should we show?
832     $action = '';
833     if (!empty($question->id) &&
834             (question_has_capability_on($question, 'edit', $question->category) ||
835                     question_has_capability_on($question, 'move', $question->category))) {
836         $action = $stredit;
837         $icon = '/t/edit';
838     } else if (!empty($question->id) &&
839             question_has_capability_on($question, 'view', $question->category)) {
840         $action = $strview;
841         $icon = '/i/info';
842     }
844     // Build the icon.
845     if ($action) {
846         if ($returnurl instanceof moodle_url) {
847             $returnurl = $returnurl->out_as_local_url(false);
848         }
849         $questionparams = array('returnurl' => $returnurl, 'cmid' => $cmid, 'id' => $question->id);
850         $questionurl = new moodle_url("$CFG->wwwroot/question/question.php", $questionparams);
851         return '<a title="' . $action . '" href="' . $questionurl->out() . '" class="questioneditbutton"><img src="' .
852                 $OUTPUT->pix_url($icon) . '" alt="' . $action . '" />' . $contentaftericon .
853                 '</a>';
854     } else if ($contentaftericon) {
855         return '<span class="questioneditbutton">' . $contentaftericon . '</span>';
856     } else {
857         return '';
858     }
861 /**
862  * @param object $quiz the quiz settings
863  * @param object $question the question
864  * @return moodle_url to preview this question with the options from this quiz.
865  */
866 function quiz_question_preview_url($quiz, $question) {
867     // Get the appropriate display options.
868     $displayoptions = mod_quiz_display_options::make_from_quiz($quiz,
869             mod_quiz_display_options::DURING);
871     $maxmark = null;
872     if (isset($question->maxmark)) {
873         $maxmark = $question->maxmark;
874     }
876     // Work out the correcte preview URL.
877     return question_preview_url($question->id, $quiz->preferredbehaviour,
878             $maxmark, $displayoptions);
881 /**
882  * @param object $quiz the quiz settings
883  * @param object $question the question
884  * @param bool $label if true, show the preview question label after the icon
885  * @return the HTML for a preview question icon.
886  */
887 function quiz_question_preview_button($quiz, $question, $label = false) {
888     global $CFG, $OUTPUT;
889     if (!question_has_capability_on($question, 'use', $question->category)) {
890         return '';
891     }
893     $url = quiz_question_preview_url($quiz, $question);
895     // Do we want a label?
896     $strpreviewlabel = '';
897     if ($label) {
898         $strpreviewlabel = get_string('preview', 'quiz');
899     }
901     // Build the icon.
902     $strpreviewquestion = get_string('previewquestion', 'quiz');
903     $image = $OUTPUT->pix_icon('t/preview', $strpreviewquestion);
905     $action = new popup_action('click', $url, 'questionpreview',
906             question_preview_popup_params());
908     return $OUTPUT->action_link($url, $image, $action, array('title' => $strpreviewquestion));
911 /**
912  * @param object $attempt the attempt.
913  * @param object $context the quiz context.
914  * @return int whether flags should be shown/editable to the current user for this attempt.
915  */
916 function quiz_get_flag_option($attempt, $context) {
917     global $USER;
918     if (!has_capability('moodle/question:flag', $context)) {
919         return question_display_options::HIDDEN;
920     } else if ($attempt->userid == $USER->id) {
921         return question_display_options::EDITABLE;
922     } else {
923         return question_display_options::VISIBLE;
924     }
927 /**
928  * Work out what state this quiz attempt is in.
929  * @param object $quiz the quiz settings
930  * @param object $attempt the quiz_attempt database row.
931  * @return int one of the mod_quiz_display_options::DURING,
932  *      IMMEDIATELY_AFTER, LATER_WHILE_OPEN or AFTER_CLOSE constants.
933  */
934 function quiz_attempt_state($quiz, $attempt) {
935     if ($attempt->timefinish == 0) {
936         return mod_quiz_display_options::DURING;
937     } else if (time() < $attempt->timefinish + 120) {
938         return mod_quiz_display_options::IMMEDIATELY_AFTER;
939     } else if (!$quiz->timeclose || time() < $quiz->timeclose) {
940         return mod_quiz_display_options::LATER_WHILE_OPEN;
941     } else {
942         return mod_quiz_display_options::AFTER_CLOSE;
943     }
946 /**
947  * The the appropraite mod_quiz_display_options object for this attempt at this
948  * quiz right now.
949  *
950  * @param object $quiz the quiz instance.
951  * @param object $attempt the attempt in question.
952  * @param $context the quiz context.
953  *
954  * @return mod_quiz_display_options
955  */
956 function quiz_get_review_options($quiz, $attempt, $context) {
957     $options = mod_quiz_display_options::make_from_quiz($quiz, quiz_attempt_state($quiz, $attempt));
959     $options->readonly = true;
960     $options->flags = quiz_get_flag_option($attempt, $context);
961     if (!empty($attempt->id)) {
962         $options->questionreviewlink = new moodle_url('/mod/quiz/reviewquestion.php',
963                 array('attempt' => $attempt->id));
964     }
966     // Show a link to the comment box only for closed attempts
967     if (!empty($attempt->id) && $attempt->timefinish && !$attempt->preview &&
968             !is_null($context) && has_capability('mod/quiz:grade', $context)) {
969         $options->manualcomment = question_display_options::VISIBLE;
970         $options->manualcommentlink = new moodle_url('/mod/quiz/comment.php',
971                 array('attempt' => $attempt->id));
972     }
974     if (!is_null($context) && !$attempt->preview &&
975             has_capability('mod/quiz:viewreports', $context) &&
976             has_capability('moodle/grade:viewhidden', $context)) {
977         // People who can see reports and hidden grades should be shown everything,
978         // except during preview when teachers want to see what students see.
979         $options->attempt = question_display_options::VISIBLE;
980         $options->correctness = question_display_options::VISIBLE;
981         $options->marks = question_display_options::MARK_AND_MAX;
982         $options->feedback = question_display_options::VISIBLE;
983         $options->numpartscorrect = question_display_options::VISIBLE;
984         $options->generalfeedback = question_display_options::VISIBLE;
985         $options->rightanswer = question_display_options::VISIBLE;
986         $options->overallfeedback = question_display_options::VISIBLE;
987         $options->history = question_display_options::VISIBLE;
989     }
991     return $options;
994 /**
995  * Combines the review options from a number of different quiz attempts.
996  * Returns an array of two ojects, so the suggested way of calling this
997  * funciton is:
998  * list($someoptions, $alloptions) = quiz_get_combined_reviewoptions(...)
999  *
1000  * @param object $quiz the quiz instance.
1001  * @param array $attempts an array of attempt objects.
1002  * @param $context the roles and permissions context,
1003  *          normally the context for the quiz module instance.
1004  *
1005  * @return array of two options objects, one showing which options are true for
1006  *          at least one of the attempts, the other showing which options are true
1007  *          for all attempts.
1008  */
1009 function quiz_get_combined_reviewoptions($quiz, $attempts) {
1010     $fields = array('feedback', 'generalfeedback', 'rightanswer', 'overallfeedback');
1011     $someoptions = new stdClass();
1012     $alloptions = new stdClass();
1013     foreach ($fields as $field) {
1014         $someoptions->$field = false;
1015         $alloptions->$field = true;
1016     }
1017     $someoptions->marks = question_display_options::HIDDEN;
1018     $alloptions->marks = question_display_options::MARK_AND_MAX;
1020     foreach ($attempts as $attempt) {
1021         $attemptoptions = mod_quiz_display_options::make_from_quiz($quiz,
1022                 quiz_attempt_state($quiz, $attempt));
1023         foreach ($fields as $field) {
1024             $someoptions->$field = $someoptions->$field || $attemptoptions->$field;
1025             $alloptions->$field = $alloptions->$field && $attemptoptions->$field;
1026         }
1027         $someoptions->marks = max($someoptions->marks, $attemptoptions->marks);
1028         $alloptions->marks = min($alloptions->marks, $attemptoptions->marks);
1029     }
1030     return array($someoptions, $alloptions);
1033 /**
1034  * Clean the question layout from various possible anomalies:
1035  * - Remove consecutive ","'s
1036  * - Remove duplicate question id's
1037  * - Remove extra "," from beginning and end
1038  * - Finally, add a ",0" in the end if there is none
1039  *
1040  * @param $string $layout the quiz layout to clean up, usually from $quiz->questions.
1041  * @param bool $removeemptypages If true, remove empty pages from the quiz. False by default.
1042  * @return $string the cleaned-up layout
1043  */
1044 function quiz_clean_layout($layout, $removeemptypages = false) {
1045     // Remove repeated ','s. This can happen when a restore fails to find the right
1046     // id to relink to.
1047     $layout = preg_replace('/,{2,}/', ',', trim($layout, ','));
1049     // Remove duplicate question ids
1050     $layout = explode(',', $layout);
1051     $cleanerlayout = array();
1052     $seen = array();
1053     foreach ($layout as $item) {
1054         if ($item == 0) {
1055             $cleanerlayout[] = '0';
1056         } else if (!in_array($item, $seen)) {
1057             $cleanerlayout[] = $item;
1058             $seen[] = $item;
1059         }
1060     }
1062     if ($removeemptypages) {
1063         // Avoid duplicate page breaks
1064         $layout = $cleanerlayout;
1065         $cleanerlayout = array();
1066         $stripfollowingbreaks = true; // Ensure breaks are stripped from the start.
1067         foreach ($layout as $item) {
1068             if ($stripfollowingbreaks && $item == 0) {
1069                 continue;
1070             }
1071             $cleanerlayout[] = $item;
1072             $stripfollowingbreaks = $item == 0;
1073         }
1074     }
1076     // Add a page break at the end if there is none
1077     if (end($cleanerlayout) !== '0') {
1078         $cleanerlayout[] = '0';
1079     }
1081     return implode(',', $cleanerlayout);
1084 /**
1085  * Get the slot for a question with a particular id.
1086  * @param object $quiz the quiz settings.
1087  * @param int $questionid the of a question in the quiz.
1088  * @return int the corresponding slot. Null if the question is not in the quiz.
1089  */
1090 function quiz_get_slot_for_question($quiz, $questionid) {
1091     $questionids = quiz_questions_in_quiz($quiz->questions);
1092     foreach (explode(',', $questionids) as $key => $id) {
1093         if ($id == $questionid) {
1094             return $key + 1;
1095         }
1096     }
1097     return null;
1100 /// FUNCTIONS FOR SENDING NOTIFICATION MESSAGES ///////////////////////////////
1102 /**
1103  * Sends a confirmation message to the student confirming that the attempt was processed.
1104  *
1105  * @param object $a lots of useful information that can be used in the message
1106  *      subject and body.
1107  *
1108  * @return int|false as for {@link message_send()}.
1109  */
1110 function quiz_send_confirmation($recipient, $a) {
1112     // Add information about the recipient to $a
1113     // Don't do idnumber. we want idnumber to be the submitter's idnumber.
1114     $a->username     = fullname($recipient);
1115     $a->userusername = $recipient->username;
1117     // Prepare message
1118     $eventdata = new stdClass();
1119     $eventdata->component         = 'mod_quiz';
1120     $eventdata->name              = 'confirmation';
1121     $eventdata->notification      = 1;
1123     $eventdata->userfrom          = get_admin();
1124     $eventdata->userto            = $recipient;
1125     $eventdata->subject           = get_string('emailconfirmsubject', 'quiz', $a);
1126     $eventdata->fullmessage       = get_string('emailconfirmbody', 'quiz', $a);
1127     $eventdata->fullmessageformat = FORMAT_PLAIN;
1128     $eventdata->fullmessagehtml   = '';
1130     $eventdata->smallmessage      = get_string('emailconfirmsmall', 'quiz', $a);
1131     $eventdata->contexturl        = $a->quizurl;
1132     $eventdata->contexturlname    = $a->quizname;
1134     // ... and send it.
1135     return message_send($eventdata);
1138 /**
1139  * Sends notification messages to the interested parties that assign the role capability
1140  *
1141  * @param object $recipient user object of the intended recipient
1142  * @param object $a associative array of replaceable fields for the templates
1143  *
1144  * @return int|false as for {@link message_send()}.
1145  */
1146 function quiz_send_notification($recipient, $submitter, $a) {
1148     global $USER;
1150     // Recipient info for template
1151     $a->useridnumber = $recipient->idnumber;
1152     $a->username     = fullname($recipient);
1153     $a->userusername = $recipient->username;
1155     // Prepare message
1156     $eventdata = new stdClass();
1157     $eventdata->component         = 'mod_quiz';
1158     $eventdata->name              = 'submission';
1159     $eventdata->notification      = 1;
1161     $eventdata->userfrom          = $submitter;
1162     $eventdata->userto            = $recipient;
1163     $eventdata->subject           = get_string('emailnotifysubject', 'quiz', $a);
1164     $eventdata->fullmessage       = get_string('emailnotifybody', 'quiz', $a);
1165     $eventdata->fullmessageformat = FORMAT_PLAIN;
1166     $eventdata->fullmessagehtml   = '';
1168     $eventdata->smallmessage      = get_string('emailnotifysmall', 'quiz', $a);
1169     $eventdata->contexturl        = $a->quizreviewurl;
1170     $eventdata->contexturlname    = $a->quizname;
1172     // ... and send it.
1173     return message_send($eventdata);
1176 /**
1177  * Send all the requried messages when a quiz attempt is submitted.
1178  *
1179  * @param object $course the course
1180  * @param object $quiz the quiz
1181  * @param object $attempt this attempt just finished
1182  * @param object $context the quiz context
1183  * @param object $cm the coursemodule for this quiz
1184  *
1185  * @return bool true if all necessary messages were sent successfully, else false.
1186  */
1187 function quiz_send_notification_messages($course, $quiz, $attempt, $context, $cm) {
1188     global $CFG, $DB;
1190     // Do nothing if required objects not present
1191     if (empty($course) or empty($quiz) or empty($attempt) or empty($context)) {
1192         throw new coding_exception('$course, $quiz, $attempt, $context and $cm must all be set.');
1193     }
1195     $submitter = $DB->get_record('user', array('id' => $attempt->userid), '*', MUST_EXIST);
1197     // Check for confirmation required
1198     $sendconfirm = false;
1199     $notifyexcludeusers = '';
1200     if (has_capability('mod/quiz:emailconfirmsubmission', $context, $submitter, false)) {
1201         $notifyexcludeusers = $submitter->id;
1202         $sendconfirm = true;
1203     }
1205     // check for notifications required
1206     $notifyfields = 'u.id, u.username, u.firstname, u.lastname, u.idnumber, u.email, u.emailstop, ' .
1207             'u.lang, u.timezone, u.mailformat, u.maildisplay';
1208     $groups = groups_get_all_groups($course->id, $submitter->id);
1209     if (is_array($groups) && count($groups) > 0) {
1210         $groups = array_keys($groups);
1211     } else if (groups_get_activity_groupmode($cm, $course) != NOGROUPS) {
1212         // If the user is not in a group, and the quiz is set to group mode,
1213         // then set $groups to a non-existant id so that only users with
1214         // 'moodle/site:accessallgroups' get notified.
1215         $groups = -1;
1216     } else {
1217         $groups = '';
1218     }
1219     $userstonotify = get_users_by_capability($context, 'mod/quiz:emailnotifysubmission',
1220             $notifyfields, '', '', '', $groups, $notifyexcludeusers, false, false, true);
1222     if (empty($userstonotify) && !$sendconfirm) {
1223         return true; // Nothing to do.
1224     }
1226     $a = new stdClass();
1227     // Course info
1228     $a->coursename      = $course->fullname;
1229     $a->courseshortname = $course->shortname;
1230     // Quiz info
1231     $a->quizname        = $quiz->name;
1232     $a->quizreporturl   = $CFG->wwwroot . '/mod/quiz/report.php?id=' . $cm->id;
1233     $a->quizreportlink  = '<a href="' . $a->quizreporturl . '">' .
1234             format_string($quiz->name) . ' report</a>';
1235     $a->quizreviewurl   = $CFG->wwwroot . '/mod/quiz/review.php?attempt=' . $attempt->id;
1236     $a->quizreviewlink  = '<a href="' . $a->quizreviewurl . '">' .
1237             format_string($quiz->name) . ' review</a>';
1238     $a->quizurl         = $CFG->wwwroot . '/mod/quiz/view.php?id=' . $cm->id;
1239     $a->quizlink        = '<a href="' . $a->quizurl . '">' . format_string($quiz->name) . '</a>';
1240     // Attempt info
1241     $a->submissiontime  = userdate($attempt->timefinish);
1242     $a->timetaken       = format_time($attempt->timefinish - $attempt->timestart);
1243     // Student who sat the quiz info
1244     $a->studentidnumber = $submitter->idnumber;
1245     $a->studentname     = fullname($submitter);
1246     $a->studentusername = $submitter->username;
1248     $allok = true;
1250     // Send notifications if required
1251     if (!empty($userstonotify)) {
1252         foreach ($userstonotify as $recipient) {
1253             $allok = $allok && quiz_send_notification($recipient, $submitter, $a);
1254         }
1255     }
1257     // Send confirmation if required. We send the student confirmation last, so
1258     // that if message sending is being intermittently buggy, which means we send
1259     // some but not all messages, and then try again later, then teachers may get
1260     // duplicate messages, but the student will always get exactly one.
1261     if ($sendconfirm) {
1262         $allok = $allok && quiz_send_confirmation($submitter, $a);
1263     }
1265     return $allok;
1268 /**
1269  * Handle the quiz_attempt_submitted event.
1270  *
1271  * This sends the confirmation and notification messages, if required.
1272  *
1273  * @param object $event the event object.
1274  */
1275 function quiz_attempt_submitted_handler($event) {
1276     global $DB;
1278     $course  = $DB->get_record('course', array('id' => $event->courseid));
1279     $quiz    = $DB->get_record('quiz', array('id' => $event->quizid));
1280     $cm      = get_coursemodule_from_id('quiz', $event->cmid, $event->courseid);
1281     $attempt = $DB->get_record('quiz_attempts', array('id' => $event->attemptid));
1283     if (!($course && $quiz && $cm && $attempt)) {
1284         // Something has been deleted since the event was raised. Therefore, the
1285         // event is no longer relevant.
1286         return true;
1287     }
1289     return quiz_send_notification_messages($course, $quiz, $attempt,
1290             get_context_instance(CONTEXT_MODULE, $cm->id), $cm);
1293 function quiz_get_js_module() {
1294     global $PAGE;
1296     return array(
1297         'name' => 'mod_quiz',
1298         'fullpath' => '/mod/quiz/module.js',
1299         'requires' => array('base', 'dom', 'event-delegate', 'event-key',
1300                 'core_question_engine'),
1301         'strings' => array(
1302             array('cancel', 'moodle'),
1303             array('flagged', 'question'),
1304             array('functiondisabledbysecuremode', 'quiz'),
1305             array('startattempt', 'quiz'),
1306             array('timesup', 'quiz'),
1307         ),
1308     );
1312 /**
1313  * An extension of question_display_options that includes the extra options used
1314  * by the quiz.
1315  *
1316  * @copyright  2010 The Open University
1317  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1318  */
1319 class mod_quiz_display_options extends question_display_options {
1320     /**#@+
1321      * @var integer bits used to indicate various times in relation to a
1322      * quiz attempt.
1323      */
1324     const DURING =            0x10000;
1325     const IMMEDIATELY_AFTER = 0x01000;
1326     const LATER_WHILE_OPEN =  0x00100;
1327     const AFTER_CLOSE =       0x00010;
1328     /**#@-*/
1330     /**
1331      * @var boolean if this is false, then the student is not allowed to review
1332      * anything about the attempt.
1333      */
1334     public $attempt = true;
1336     /**
1337      * @var boolean if this is false, then the student is not allowed to review
1338      * anything about the attempt.
1339      */
1340     public $overallfeedback = self::VISIBLE;
1342     /**
1343      * Set up the various options from the quiz settings, and a time constant.
1344      * @param object $quiz the quiz settings.
1345      * @param int $one of the {@link DURING}, {@link IMMEDIATELY_AFTER},
1346      * {@link LATER_WHILE_OPEN} or {@link AFTER_CLOSE} constants.
1347      * @return mod_quiz_display_options set up appropriately.
1348      */
1349     public static function make_from_quiz($quiz, $when) {
1350         $options = new self();
1352         $options->attempt = self::extract($quiz->reviewattempt, $when, true, false);
1353         $options->correctness = self::extract($quiz->reviewcorrectness, $when);
1354         $options->marks = self::extract($quiz->reviewmarks, $when,
1355                 self::MARK_AND_MAX, self::MAX_ONLY);
1356         $options->feedback = self::extract($quiz->reviewspecificfeedback, $when);
1357         $options->generalfeedback = self::extract($quiz->reviewgeneralfeedback, $when);
1358         $options->rightanswer = self::extract($quiz->reviewrightanswer, $when);
1359         $options->overallfeedback = self::extract($quiz->reviewoverallfeedback, $when);
1361         $options->numpartscorrect = $options->feedback;
1363         if ($quiz->questiondecimalpoints != -1) {
1364             $options->markdp = $quiz->questiondecimalpoints;
1365         } else {
1366             $options->markdp = $quiz->decimalpoints;
1367         }
1369         return $options;
1370     }
1372     protected static function extract($bitmask, $bit,
1373             $whenset = self::VISIBLE, $whennotset = self::HIDDEN) {
1374         if ($bitmask & $bit) {
1375             return $whenset;
1376         } else {
1377             return $whennotset;
1378         }
1379     }
1383 /**
1384  * A {@link qubaid_condition} for finding all the question usages belonging to
1385  * a particular quiz.
1386  *
1387  * @copyright  2010 The Open University
1388  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1389  */
1390 class qubaids_for_quiz extends qubaid_join {
1391     public function __construct($quizid, $includepreviews = true, $onlyfinished = false) {
1392         $where = 'quiza.quiz = :quizaquiz';
1393         if (!$includepreviews) {
1394             $where .= ' AND preview = 0';
1395         }
1396         if ($onlyfinished) {
1397             $where .= ' AND timefinish <> 0';
1398         }
1400         parent::__construct('{quiz_attempts} quiza', 'quiza.uniqueid', $where,
1401                 array('quizaquiz' => $quizid));
1402     }