Merge branch 'MDL-64878-master' of git://github.com/damyon/moodle
[moodle.git] / mod / quiz / lib.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 for the quiz module.
19  *
20  * This contains functions that are called also from outside the quiz module
21  * Functions that are only called by the quiz module itself are in {@link locallib.php}
22  *
23  * @package    mod_quiz
24  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
29 defined('MOODLE_INTERNAL') || die();
31 require_once($CFG->dirroot . '/calendar/lib.php');
34 /**#@+
35  * Option controlling what options are offered on the quiz settings form.
36  */
37 define('QUIZ_MAX_ATTEMPT_OPTION', 10);
38 define('QUIZ_MAX_QPP_OPTION', 50);
39 define('QUIZ_MAX_DECIMAL_OPTION', 5);
40 define('QUIZ_MAX_Q_DECIMAL_OPTION', 7);
41 /**#@-*/
43 /**#@+
44  * Options determining how the grades from individual attempts are combined to give
45  * the overall grade for a user
46  */
47 define('QUIZ_GRADEHIGHEST', '1');
48 define('QUIZ_GRADEAVERAGE', '2');
49 define('QUIZ_ATTEMPTFIRST', '3');
50 define('QUIZ_ATTEMPTLAST',  '4');
51 /**#@-*/
53 /**
54  * @var int If start and end date for the quiz are more than this many seconds apart
55  * they will be represented by two separate events in the calendar
56  */
57 define('QUIZ_MAX_EVENT_LENGTH', 5*24*60*60); // 5 days.
59 /**#@+
60  * Options for navigation method within quizzes.
61  */
62 define('QUIZ_NAVMETHOD_FREE', 'free');
63 define('QUIZ_NAVMETHOD_SEQ',  'sequential');
64 /**#@-*/
66 /**
67  * Event types.
68  */
69 define('QUIZ_EVENT_TYPE_OPEN', 'open');
70 define('QUIZ_EVENT_TYPE_CLOSE', 'close');
72 /**
73  * Given an object containing all the necessary data,
74  * (defined by the form in mod_form.php) this function
75  * will create a new instance and return the id number
76  * of the new instance.
77  *
78  * @param object $quiz the data that came from the form.
79  * @return mixed the id of the new instance on success,
80  *          false or a string error message on failure.
81  */
82 function quiz_add_instance($quiz) {
83     global $DB;
84     $cmid = $quiz->coursemodule;
86     // Process the options from the form.
87     $quiz->created = time();
88     $result = quiz_process_options($quiz);
89     if ($result && is_string($result)) {
90         return $result;
91     }
93     // Try to store it in the database.
94     $quiz->id = $DB->insert_record('quiz', $quiz);
96     // Create the first section for this quiz.
97     $DB->insert_record('quiz_sections', array('quizid' => $quiz->id,
98             'firstslot' => 1, 'heading' => '', 'shufflequestions' => 0));
100     // Do the processing required after an add or an update.
101     quiz_after_add_or_update($quiz);
103     return $quiz->id;
106 /**
107  * Given an object containing all the necessary data,
108  * (defined by the form in mod_form.php) this function
109  * will update an existing instance with new data.
110  *
111  * @param object $quiz the data that came from the form.
112  * @return mixed true on success, false or a string error message on failure.
113  */
114 function quiz_update_instance($quiz, $mform) {
115     global $CFG, $DB;
116     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
118     // Process the options from the form.
119     $result = quiz_process_options($quiz);
120     if ($result && is_string($result)) {
121         return $result;
122     }
124     // Get the current value, so we can see what changed.
125     $oldquiz = $DB->get_record('quiz', array('id' => $quiz->instance));
127     // We need two values from the existing DB record that are not in the form,
128     // in some of the function calls below.
129     $quiz->sumgrades = $oldquiz->sumgrades;
130     $quiz->grade     = $oldquiz->grade;
132     // Update the database.
133     $quiz->id = $quiz->instance;
134     $DB->update_record('quiz', $quiz);
136     // Do the processing required after an add or an update.
137     quiz_after_add_or_update($quiz);
139     if ($oldquiz->grademethod != $quiz->grademethod) {
140         quiz_update_all_final_grades($quiz);
141         quiz_update_grades($quiz);
142     }
144     $quizdateschanged = $oldquiz->timelimit   != $quiz->timelimit
145                      || $oldquiz->timeclose   != $quiz->timeclose
146                      || $oldquiz->graceperiod != $quiz->graceperiod;
147     if ($quizdateschanged) {
148         quiz_update_open_attempts(array('quizid' => $quiz->id));
149     }
151     // Delete any previous preview attempts.
152     quiz_delete_previews($quiz);
154     // Repaginate, if asked to.
155     if (!empty($quiz->repaginatenow)) {
156         quiz_repaginate_questions($quiz->id, $quiz->questionsperpage);
157     }
159     return true;
162 /**
163  * Given an ID of an instance of this module,
164  * this function will permanently delete the instance
165  * and any data that depends on it.
166  *
167  * @param int $id the id of the quiz to delete.
168  * @return bool success or failure.
169  */
170 function quiz_delete_instance($id) {
171     global $DB;
173     $quiz = $DB->get_record('quiz', array('id' => $id), '*', MUST_EXIST);
175     quiz_delete_all_attempts($quiz);
176     quiz_delete_all_overrides($quiz);
178     // Look for random questions that may no longer be used when this quiz is gone.
179     $sql = "SELECT q.id
180               FROM {quiz_slots} slot
181               JOIN {question} q ON q.id = slot.questionid
182              WHERE slot.quizid = ? AND q.qtype = ?";
183     $questionids = $DB->get_fieldset_sql($sql, array($quiz->id, 'random'));
185     // We need to do the following deletes before we try and delete randoms, otherwise they would still be 'in use'.
186     $quizslots = $DB->get_fieldset_select('quiz_slots', 'id', 'quizid = ?', array($quiz->id));
187     $DB->delete_records_list('quiz_slot_tags', 'slotid', $quizslots);
188     $DB->delete_records('quiz_slots', array('quizid' => $quiz->id));
189     $DB->delete_records('quiz_sections', array('quizid' => $quiz->id));
191     foreach ($questionids as $questionid) {
192         question_delete_question($questionid);
193     }
195     $DB->delete_records('quiz_feedback', array('quizid' => $quiz->id));
197     quiz_access_manager::delete_settings($quiz);
199     $events = $DB->get_records('event', array('modulename' => 'quiz', 'instance' => $quiz->id));
200     foreach ($events as $event) {
201         $event = calendar_event::load($event);
202         $event->delete();
203     }
205     quiz_grade_item_delete($quiz);
206     // We must delete the module record after we delete the grade item.
207     $DB->delete_records('quiz', array('id' => $quiz->id));
209     return true;
212 /**
213  * Deletes a quiz override from the database and clears any corresponding calendar events
214  *
215  * @param object $quiz The quiz object.
216  * @param int $overrideid The id of the override being deleted
217  * @param bool $log Whether to trigger logs.
218  * @return bool true on success
219  */
220 function quiz_delete_override($quiz, $overrideid, $log = true) {
221     global $DB;
223     if (!isset($quiz->cmid)) {
224         $cm = get_coursemodule_from_instance('quiz', $quiz->id, $quiz->course);
225         $quiz->cmid = $cm->id;
226     }
228     $override = $DB->get_record('quiz_overrides', array('id' => $overrideid), '*', MUST_EXIST);
230     // Delete the events.
231     if (isset($override->groupid)) {
232         // Create the search array for a group override.
233         $eventsearcharray = array('modulename' => 'quiz',
234             'instance' => $quiz->id, 'groupid' => (int)$override->groupid);
235     } else {
236         // Create the search array for a user override.
237         $eventsearcharray = array('modulename' => 'quiz',
238             'instance' => $quiz->id, 'userid' => (int)$override->userid);
239     }
240     $events = $DB->get_records('event', $eventsearcharray);
241     foreach ($events as $event) {
242         $eventold = calendar_event::load($event);
243         $eventold->delete();
244     }
246     $DB->delete_records('quiz_overrides', array('id' => $overrideid));
248     if ($log) {
249         // Set the common parameters for one of the events we will be triggering.
250         $params = array(
251             'objectid' => $override->id,
252             'context' => context_module::instance($quiz->cmid),
253             'other' => array(
254                 'quizid' => $override->quiz
255             )
256         );
257         // Determine which override deleted event to fire.
258         if (!empty($override->userid)) {
259             $params['relateduserid'] = $override->userid;
260             $event = \mod_quiz\event\user_override_deleted::create($params);
261         } else {
262             $params['other']['groupid'] = $override->groupid;
263             $event = \mod_quiz\event\group_override_deleted::create($params);
264         }
266         // Trigger the override deleted event.
267         $event->add_record_snapshot('quiz_overrides', $override);
268         $event->trigger();
269     }
271     return true;
274 /**
275  * Deletes all quiz overrides from the database and clears any corresponding calendar events
276  *
277  * @param object $quiz The quiz object.
278  * @param bool $log Whether to trigger logs.
279  */
280 function quiz_delete_all_overrides($quiz, $log = true) {
281     global $DB;
283     $overrides = $DB->get_records('quiz_overrides', array('quiz' => $quiz->id), 'id');
284     foreach ($overrides as $override) {
285         quiz_delete_override($quiz, $override->id, $log);
286     }
289 /**
290  * Updates a quiz object with override information for a user.
291  *
292  * Algorithm:  For each quiz setting, if there is a matching user-specific override,
293  *   then use that otherwise, if there are group-specific overrides, return the most
294  *   lenient combination of them.  If neither applies, leave the quiz setting unchanged.
295  *
296  *   Special case: if there is more than one password that applies to the user, then
297  *   quiz->extrapasswords will contain an array of strings giving the remaining
298  *   passwords.
299  *
300  * @param object $quiz The quiz object.
301  * @param int $userid The userid.
302  * @return object $quiz The updated quiz object.
303  */
304 function quiz_update_effective_access($quiz, $userid) {
305     global $DB;
307     // Check for user override.
308     $override = $DB->get_record('quiz_overrides', array('quiz' => $quiz->id, 'userid' => $userid));
310     if (!$override) {
311         $override = new stdClass();
312         $override->timeopen = null;
313         $override->timeclose = null;
314         $override->timelimit = null;
315         $override->attempts = null;
316         $override->password = null;
317     }
319     // Check for group overrides.
320     $groupings = groups_get_user_groups($quiz->course, $userid);
322     if (!empty($groupings[0])) {
323         // Select all overrides that apply to the User's groups.
324         list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
325         $sql = "SELECT * FROM {quiz_overrides}
326                 WHERE groupid $extra AND quiz = ?";
327         $params[] = $quiz->id;
328         $records = $DB->get_records_sql($sql, $params);
330         // Combine the overrides.
331         $opens = array();
332         $closes = array();
333         $limits = array();
334         $attempts = array();
335         $passwords = array();
337         foreach ($records as $gpoverride) {
338             if (isset($gpoverride->timeopen)) {
339                 $opens[] = $gpoverride->timeopen;
340             }
341             if (isset($gpoverride->timeclose)) {
342                 $closes[] = $gpoverride->timeclose;
343             }
344             if (isset($gpoverride->timelimit)) {
345                 $limits[] = $gpoverride->timelimit;
346             }
347             if (isset($gpoverride->attempts)) {
348                 $attempts[] = $gpoverride->attempts;
349             }
350             if (isset($gpoverride->password)) {
351                 $passwords[] = $gpoverride->password;
352             }
353         }
354         // If there is a user override for a setting, ignore the group override.
355         if (is_null($override->timeopen) && count($opens)) {
356             $override->timeopen = min($opens);
357         }
358         if (is_null($override->timeclose) && count($closes)) {
359             if (in_array(0, $closes)) {
360                 $override->timeclose = 0;
361             } else {
362                 $override->timeclose = max($closes);
363             }
364         }
365         if (is_null($override->timelimit) && count($limits)) {
366             if (in_array(0, $limits)) {
367                 $override->timelimit = 0;
368             } else {
369                 $override->timelimit = max($limits);
370             }
371         }
372         if (is_null($override->attempts) && count($attempts)) {
373             if (in_array(0, $attempts)) {
374                 $override->attempts = 0;
375             } else {
376                 $override->attempts = max($attempts);
377             }
378         }
379         if (is_null($override->password) && count($passwords)) {
380             $override->password = array_shift($passwords);
381             if (count($passwords)) {
382                 $override->extrapasswords = $passwords;
383             }
384         }
386     }
388     // Merge with quiz defaults.
389     $keys = array('timeopen', 'timeclose', 'timelimit', 'attempts', 'password', 'extrapasswords');
390     foreach ($keys as $key) {
391         if (isset($override->{$key})) {
392             $quiz->{$key} = $override->{$key};
393         }
394     }
396     return $quiz;
399 /**
400  * Delete all the attempts belonging to a quiz.
401  *
402  * @param object $quiz The quiz object.
403  */
404 function quiz_delete_all_attempts($quiz) {
405     global $CFG, $DB;
406     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
407     question_engine::delete_questions_usage_by_activities(new qubaids_for_quiz($quiz->id));
408     $DB->delete_records('quiz_attempts', array('quiz' => $quiz->id));
409     $DB->delete_records('quiz_grades', array('quiz' => $quiz->id));
412 /**
413  * Delete all the attempts belonging to a user in a particular quiz.
414  *
415  * @param object $quiz The quiz object.
416  * @param object $user The user object.
417  */
418 function quiz_delete_user_attempts($quiz, $user) {
419     global $CFG, $DB;
420     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
421     question_engine::delete_questions_usage_by_activities(new qubaids_for_quiz_user($quiz->get_quizid(), $user->id));
422     $params = [
423         'quiz' => $quiz->get_quizid(),
424         'userid' => $user->id,
425     ];
426     $DB->delete_records('quiz_attempts', $params);
427     $DB->delete_records('quiz_grades', $params);
430 /**
431  * Get the best current grade for a particular user in a quiz.
432  *
433  * @param object $quiz the quiz settings.
434  * @param int $userid the id of the user.
435  * @return float the user's current grade for this quiz, or null if this user does
436  * not have a grade on this quiz.
437  */
438 function quiz_get_best_grade($quiz, $userid) {
439     global $DB;
440     $grade = $DB->get_field('quiz_grades', 'grade',
441             array('quiz' => $quiz->id, 'userid' => $userid));
443     // Need to detect errors/no result, without catching 0 grades.
444     if ($grade === false) {
445         return null;
446     }
448     return $grade + 0; // Convert to number.
451 /**
452  * Is this a graded quiz? If this method returns true, you can assume that
453  * $quiz->grade and $quiz->sumgrades are non-zero (for example, if you want to
454  * divide by them).
455  *
456  * @param object $quiz a row from the quiz table.
457  * @return bool whether this is a graded quiz.
458  */
459 function quiz_has_grades($quiz) {
460     return $quiz->grade >= 0.000005 && $quiz->sumgrades >= 0.000005;
463 /**
464  * Does this quiz allow multiple tries?
465  *
466  * @return bool
467  */
468 function quiz_allows_multiple_tries($quiz) {
469     $bt = question_engine::get_behaviour_type($quiz->preferredbehaviour);
470     return $bt->allows_multiple_submitted_responses();
473 /**
474  * Return a small object with summary information about what a
475  * user has done with a given particular instance of this module
476  * Used for user activity reports.
477  * $return->time = the time they did it
478  * $return->info = a short text description
479  *
480  * @param object $course
481  * @param object $user
482  * @param object $mod
483  * @param object $quiz
484  * @return object|null
485  */
486 function quiz_user_outline($course, $user, $mod, $quiz) {
487     global $DB, $CFG;
488     require_once($CFG->libdir . '/gradelib.php');
489     $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id);
491     if (empty($grades->items[0]->grades)) {
492         return null;
493     } else {
494         $grade = reset($grades->items[0]->grades);
495     }
497     $result = new stdClass();
498     // If the user can't see hidden grades, don't return that information.
499     $gitem = grade_item::fetch(array('id' => $grades->items[0]->id));
500     if (!$gitem->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
501         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
502     } else {
503         $result->info = get_string('grade') . ': ' . get_string('hidden', 'grades');
504     }
506     // Datesubmitted == time created. dategraded == time modified or time overridden
507     // if grade was last modified by the user themselves use date graded. Otherwise use
508     // date submitted.
509     // TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704.
510     if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
511         $result->time = $grade->dategraded;
512     } else {
513         $result->time = $grade->datesubmitted;
514     }
516     return $result;
519 /**
520  * Print a detailed representation of what a  user has done with
521  * a given particular instance of this module, for user activity reports.
522  *
523  * @param object $course
524  * @param object $user
525  * @param object $mod
526  * @param object $quiz
527  * @return bool
528  */
529 function quiz_user_complete($course, $user, $mod, $quiz) {
530     global $DB, $CFG, $OUTPUT;
531     require_once($CFG->libdir . '/gradelib.php');
532     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
534     $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id);
535     if (!empty($grades->items[0]->grades)) {
536         $grade = reset($grades->items[0]->grades);
537         // If the user can't see hidden grades, don't return that information.
538         $gitem = grade_item::fetch(array('id' => $grades->items[0]->id));
539         if (!$gitem->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
540             echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
541             if ($grade->str_feedback) {
542                 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
543             }
544         } else {
545             echo $OUTPUT->container(get_string('grade') . ': ' . get_string('hidden', 'grades'));
546             if ($grade->str_feedback) {
547                 echo $OUTPUT->container(get_string('feedback').': '.get_string('hidden', 'grades'));
548             }
549         }
550     }
552     if ($attempts = $DB->get_records('quiz_attempts',
553             array('userid' => $user->id, 'quiz' => $quiz->id), 'attempt')) {
554         foreach ($attempts as $attempt) {
555             echo get_string('attempt', 'quiz', $attempt->attempt) . ': ';
556             if ($attempt->state != quiz_attempt::FINISHED) {
557                 echo quiz_attempt_state_name($attempt->state);
558             } else {
559                 if (!isset($gitem)) {
560                     if (!empty($grades->items[0]->grades)) {
561                         $gitem = grade_item::fetch(array('id' => $grades->items[0]->id));
562                     } else {
563                         $gitem = new stdClass();
564                         $gitem->hidden = true;
565                     }
566                 }
567                 if (!$gitem->hidden || has_capability('moodle/grade:viewhidden', context_course::instance($course->id))) {
568                     echo quiz_format_grade($quiz, $attempt->sumgrades) . '/' . quiz_format_grade($quiz, $quiz->sumgrades);
569                 } else {
570                     echo get_string('hidden', 'grades');
571                 }
572             }
573             echo ' - '.userdate($attempt->timemodified).'<br />';
574         }
575     } else {
576         print_string('noattempts', 'quiz');
577     }
579     return true;
583 /**
584  * @param int|array $quizids A quiz ID, or an array of quiz IDs.
585  * @param int $userid the userid.
586  * @param string $status 'all', 'finished' or 'unfinished' to control
587  * @param bool $includepreviews
588  * @return an array of all the user's attempts at this quiz. Returns an empty
589  *      array if there are none.
590  */
591 function quiz_get_user_attempts($quizids, $userid, $status = 'finished', $includepreviews = false) {
592     global $DB, $CFG;
593     // TODO MDL-33071 it is very annoying to have to included all of locallib.php
594     // just to get the quiz_attempt::FINISHED constants, but I will try to sort
595     // that out properly for Moodle 2.4. For now, I will just do a quick fix for
596     // MDL-33048.
597     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
599     $params = array();
600     switch ($status) {
601         case 'all':
602             $statuscondition = '';
603             break;
605         case 'finished':
606             $statuscondition = ' AND state IN (:state1, :state2)';
607             $params['state1'] = quiz_attempt::FINISHED;
608             $params['state2'] = quiz_attempt::ABANDONED;
609             break;
611         case 'unfinished':
612             $statuscondition = ' AND state IN (:state1, :state2)';
613             $params['state1'] = quiz_attempt::IN_PROGRESS;
614             $params['state2'] = quiz_attempt::OVERDUE;
615             break;
616     }
618     $quizids = (array) $quizids;
619     list($insql, $inparams) = $DB->get_in_or_equal($quizids, SQL_PARAMS_NAMED);
620     $params += $inparams;
621     $params['userid'] = $userid;
623     $previewclause = '';
624     if (!$includepreviews) {
625         $previewclause = ' AND preview = 0';
626     }
628     return $DB->get_records_select('quiz_attempts',
629             "quiz $insql AND userid = :userid" . $previewclause . $statuscondition,
630             $params, 'quiz, attempt ASC');
633 /**
634  * Return grade for given user or all users.
635  *
636  * @param int $quizid id of quiz
637  * @param int $userid optional user id, 0 means all users
638  * @return array array of grades, false if none. These are raw grades. They should
639  * be processed with quiz_format_grade for display.
640  */
641 function quiz_get_user_grades($quiz, $userid = 0) {
642     global $CFG, $DB;
644     $params = array($quiz->id);
645     $usertest = '';
646     if ($userid) {
647         $params[] = $userid;
648         $usertest = 'AND u.id = ?';
649     }
650     return $DB->get_records_sql("
651             SELECT
652                 u.id,
653                 u.id AS userid,
654                 qg.grade AS rawgrade,
655                 qg.timemodified AS dategraded,
656                 MAX(qa.timefinish) AS datesubmitted
658             FROM {user} u
659             JOIN {quiz_grades} qg ON u.id = qg.userid
660             JOIN {quiz_attempts} qa ON qa.quiz = qg.quiz AND qa.userid = u.id
662             WHERE qg.quiz = ?
663             $usertest
664             GROUP BY u.id, qg.grade, qg.timemodified", $params);
667 /**
668  * Round a grade to to the correct number of decimal places, and format it for display.
669  *
670  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
671  * @param float $grade The grade to round.
672  * @return float
673  */
674 function quiz_format_grade($quiz, $grade) {
675     if (is_null($grade)) {
676         return get_string('notyetgraded', 'quiz');
677     }
678     return format_float($grade, $quiz->decimalpoints);
681 /**
682  * Determine the correct number of decimal places required to format a grade.
683  *
684  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
685  * @return integer
686  */
687 function quiz_get_grade_format($quiz) {
688     if (empty($quiz->questiondecimalpoints)) {
689         $quiz->questiondecimalpoints = -1;
690     }
692     if ($quiz->questiondecimalpoints == -1) {
693         return $quiz->decimalpoints;
694     }
696     return $quiz->questiondecimalpoints;
699 /**
700  * Round a grade to the correct number of decimal places, and format it for display.
701  *
702  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
703  * @param float $grade The grade to round.
704  * @return float
705  */
706 function quiz_format_question_grade($quiz, $grade) {
707     return format_float($grade, quiz_get_grade_format($quiz));
710 /**
711  * Update grades in central gradebook
712  *
713  * @category grade
714  * @param object $quiz the quiz settings.
715  * @param int $userid specific user only, 0 means all users.
716  * @param bool $nullifnone If a single user is specified and $nullifnone is true a grade item with a null rawgrade will be inserted
717  */
718 function quiz_update_grades($quiz, $userid = 0, $nullifnone = true) {
719     global $CFG, $DB;
720     require_once($CFG->libdir . '/gradelib.php');
722     if ($quiz->grade == 0) {
723         quiz_grade_item_update($quiz);
725     } else if ($grades = quiz_get_user_grades($quiz, $userid)) {
726         quiz_grade_item_update($quiz, $grades);
728     } else if ($userid && $nullifnone) {
729         $grade = new stdClass();
730         $grade->userid = $userid;
731         $grade->rawgrade = null;
732         quiz_grade_item_update($quiz, $grade);
734     } else {
735         quiz_grade_item_update($quiz);
736     }
739 /**
740  * Create or update the grade item for given quiz
741  *
742  * @category grade
743  * @param object $quiz object with extra cmidnumber
744  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
745  * @return int 0 if ok, error code otherwise
746  */
747 function quiz_grade_item_update($quiz, $grades = null) {
748     global $CFG, $OUTPUT;
749     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
750     require_once($CFG->libdir . '/gradelib.php');
752     if (array_key_exists('cmidnumber', $quiz)) { // May not be always present.
753         $params = array('itemname' => $quiz->name, 'idnumber' => $quiz->cmidnumber);
754     } else {
755         $params = array('itemname' => $quiz->name);
756     }
758     if ($quiz->grade > 0) {
759         $params['gradetype'] = GRADE_TYPE_VALUE;
760         $params['grademax']  = $quiz->grade;
761         $params['grademin']  = 0;
763     } else {
764         $params['gradetype'] = GRADE_TYPE_NONE;
765     }
767     // What this is trying to do:
768     // 1. If the quiz is set to not show grades while the quiz is still open,
769     //    and is set to show grades after the quiz is closed, then create the
770     //    grade_item with a show-after date that is the quiz close date.
771     // 2. If the quiz is set to not show grades at either of those times,
772     //    create the grade_item as hidden.
773     // 3. If the quiz is set to show grades, create the grade_item visible.
774     $openreviewoptions = mod_quiz_display_options::make_from_quiz($quiz,
775             mod_quiz_display_options::LATER_WHILE_OPEN);
776     $closedreviewoptions = mod_quiz_display_options::make_from_quiz($quiz,
777             mod_quiz_display_options::AFTER_CLOSE);
778     if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX &&
779             $closedreviewoptions->marks < question_display_options::MARK_AND_MAX) {
780         $params['hidden'] = 1;
782     } else if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX &&
783             $closedreviewoptions->marks >= question_display_options::MARK_AND_MAX) {
784         if ($quiz->timeclose) {
785             $params['hidden'] = $quiz->timeclose;
786         } else {
787             $params['hidden'] = 1;
788         }
790     } else {
791         // Either
792         // a) both open and closed enabled
793         // b) open enabled, closed disabled - we can not "hide after",
794         //    grades are kept visible even after closing.
795         $params['hidden'] = 0;
796     }
798     if (!$params['hidden']) {
799         // If the grade item is not hidden by the quiz logic, then we need to
800         // hide it if the quiz is hidden from students.
801         if (property_exists($quiz, 'visible')) {
802             // Saving the quiz form, and cm not yet updated in the database.
803             $params['hidden'] = !$quiz->visible;
804         } else {
805             $cm = get_coursemodule_from_instance('quiz', $quiz->id);
806             $params['hidden'] = !$cm->visible;
807         }
808     }
810     if ($grades  === 'reset') {
811         $params['reset'] = true;
812         $grades = null;
813     }
815     $gradebook_grades = grade_get_grades($quiz->course, 'mod', 'quiz', $quiz->id);
816     if (!empty($gradebook_grades->items)) {
817         $grade_item = $gradebook_grades->items[0];
818         if ($grade_item->locked) {
819             // NOTE: this is an extremely nasty hack! It is not a bug if this confirmation fails badly. --skodak.
820             $confirm_regrade = optional_param('confirm_regrade', 0, PARAM_INT);
821             if (!$confirm_regrade) {
822                 if (!AJAX_SCRIPT) {
823                     $message = get_string('gradeitemislocked', 'grades');
824                     $back_link = $CFG->wwwroot . '/mod/quiz/report.php?q=' . $quiz->id .
825                             '&amp;mode=overview';
826                     $regrade_link = qualified_me() . '&amp;confirm_regrade=1';
827                     echo $OUTPUT->box_start('generalbox', 'notice');
828                     echo '<p>'. $message .'</p>';
829                     echo $OUTPUT->container_start('buttons');
830                     echo $OUTPUT->single_button($regrade_link, get_string('regradeanyway', 'grades'));
831                     echo $OUTPUT->single_button($back_link,  get_string('cancel'));
832                     echo $OUTPUT->container_end();
833                     echo $OUTPUT->box_end();
834                 }
835                 return GRADE_UPDATE_ITEM_LOCKED;
836             }
837         }
838     }
840     return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0, $grades, $params);
843 /**
844  * Delete grade item for given quiz
845  *
846  * @category grade
847  * @param object $quiz object
848  * @return object quiz
849  */
850 function quiz_grade_item_delete($quiz) {
851     global $CFG;
852     require_once($CFG->libdir . '/gradelib.php');
854     return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0,
855             null, array('deleted' => 1));
858 /**
859  * This standard function will check all instances of this module
860  * and make sure there are up-to-date events created for each of them.
861  * If courseid = 0, then every quiz event in the site is checked, else
862  * only quiz events belonging to the course specified are checked.
863  * This function is used, in its new format, by restore_refresh_events()
864  *
865  * @param int $courseid
866  * @param int|stdClass $instance Quiz module instance or ID.
867  * @param int|stdClass $cm Course module object or ID (not used in this module).
868  * @return bool
869  */
870 function quiz_refresh_events($courseid = 0, $instance = null, $cm = null) {
871     global $DB;
873     // If we have instance information then we can just update the one event instead of updating all events.
874     if (isset($instance)) {
875         if (!is_object($instance)) {
876             $instance = $DB->get_record('quiz', array('id' => $instance), '*', MUST_EXIST);
877         }
878         quiz_update_events($instance);
879         return true;
880     }
882     if ($courseid == 0) {
883         if (!$quizzes = $DB->get_records('quiz')) {
884             return true;
885         }
886     } else {
887         if (!$quizzes = $DB->get_records('quiz', array('course' => $courseid))) {
888             return true;
889         }
890     }
892     foreach ($quizzes as $quiz) {
893         quiz_update_events($quiz);
894     }
896     return true;
899 /**
900  * Returns all quiz graded users since a given time for specified quiz
901  */
902 function quiz_get_recent_mod_activity(&$activities, &$index, $timestart,
903         $courseid, $cmid, $userid = 0, $groupid = 0) {
904     global $CFG, $USER, $DB;
905     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
907     $course = get_course($courseid);
908     $modinfo = get_fast_modinfo($course);
910     $cm = $modinfo->cms[$cmid];
911     $quiz = $DB->get_record('quiz', array('id' => $cm->instance));
913     if ($userid) {
914         $userselect = "AND u.id = :userid";
915         $params['userid'] = $userid;
916     } else {
917         $userselect = '';
918     }
920     if ($groupid) {
921         $groupselect = 'AND gm.groupid = :groupid';
922         $groupjoin   = 'JOIN {groups_members} gm ON  gm.userid=u.id';
923         $params['groupid'] = $groupid;
924     } else {
925         $groupselect = '';
926         $groupjoin   = '';
927     }
929     $params['timestart'] = $timestart;
930     $params['quizid'] = $quiz->id;
932     $ufields = user_picture::fields('u', null, 'useridagain');
933     if (!$attempts = $DB->get_records_sql("
934               SELECT qa.*,
935                      {$ufields}
936                 FROM {quiz_attempts} qa
937                      JOIN {user} u ON u.id = qa.userid
938                      $groupjoin
939                WHERE qa.timefinish > :timestart
940                  AND qa.quiz = :quizid
941                  AND qa.preview = 0
942                      $userselect
943                      $groupselect
944             ORDER BY qa.timefinish ASC", $params)) {
945         return;
946     }
948     $context         = context_module::instance($cm->id);
949     $accessallgroups = has_capability('moodle/site:accessallgroups', $context);
950     $viewfullnames   = has_capability('moodle/site:viewfullnames', $context);
951     $grader          = has_capability('mod/quiz:viewreports', $context);
952     $groupmode       = groups_get_activity_groupmode($cm, $course);
954     $usersgroups = null;
955     $aname = format_string($cm->name, true);
956     foreach ($attempts as $attempt) {
957         if ($attempt->userid != $USER->id) {
958             if (!$grader) {
959                 // Grade permission required.
960                 continue;
961             }
963             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
964                 $usersgroups = groups_get_all_groups($course->id,
965                         $attempt->userid, $cm->groupingid);
966                 $usersgroups = array_keys($usersgroups);
967                 if (!array_intersect($usersgroups, $modinfo->get_groups($cm->groupingid))) {
968                     continue;
969                 }
970             }
971         }
973         $options = quiz_get_review_options($quiz, $attempt, $context);
975         $tmpactivity = new stdClass();
977         $tmpactivity->type       = 'quiz';
978         $tmpactivity->cmid       = $cm->id;
979         $tmpactivity->name       = $aname;
980         $tmpactivity->sectionnum = $cm->sectionnum;
981         $tmpactivity->timestamp  = $attempt->timefinish;
983         $tmpactivity->content = new stdClass();
984         $tmpactivity->content->attemptid = $attempt->id;
985         $tmpactivity->content->attempt   = $attempt->attempt;
986         if (quiz_has_grades($quiz) && $options->marks >= question_display_options::MARK_AND_MAX) {
987             $tmpactivity->content->sumgrades = quiz_format_grade($quiz, $attempt->sumgrades);
988             $tmpactivity->content->maxgrade  = quiz_format_grade($quiz, $quiz->sumgrades);
989         } else {
990             $tmpactivity->content->sumgrades = null;
991             $tmpactivity->content->maxgrade  = null;
992         }
994         $tmpactivity->user = user_picture::unalias($attempt, null, 'useridagain');
995         $tmpactivity->user->fullname  = fullname($tmpactivity->user, $viewfullnames);
997         $activities[$index++] = $tmpactivity;
998     }
1001 function quiz_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
1002     global $CFG, $OUTPUT;
1004     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
1006     echo '<tr><td class="userpicture" valign="top">';
1007     echo $OUTPUT->user_picture($activity->user, array('courseid' => $courseid));
1008     echo '</td><td>';
1010     if ($detail) {
1011         $modname = $modnames[$activity->type];
1012         echo '<div class="title">';
1013         echo $OUTPUT->image_icon('icon', $modname, $activity->type);
1014         echo '<a href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' .
1015                 $activity->cmid . '">' . $activity->name . '</a>';
1016         echo '</div>';
1017     }
1019     echo '<div class="grade">';
1020     echo  get_string('attempt', 'quiz', $activity->content->attempt);
1021     if (isset($activity->content->maxgrade)) {
1022         $grades = $activity->content->sumgrades . ' / ' . $activity->content->maxgrade;
1023         echo ': (<a href="' . $CFG->wwwroot . '/mod/quiz/review.php?attempt=' .
1024                 $activity->content->attemptid . '">' . $grades . '</a>)';
1025     }
1026     echo '</div>';
1028     echo '<div class="user">';
1029     echo '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $activity->user->id .
1030             '&amp;course=' . $courseid . '">' . $activity->user->fullname .
1031             '</a> - ' . userdate($activity->timestamp);
1032     echo '</div>';
1034     echo '</td></tr></table>';
1036     return;
1039 /**
1040  * Pre-process the quiz options form data, making any necessary adjustments.
1041  * Called by add/update instance in this file.
1042  *
1043  * @param object $quiz The variables set on the form.
1044  */
1045 function quiz_process_options($quiz) {
1046     global $CFG;
1047     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
1048     require_once($CFG->libdir . '/questionlib.php');
1050     $quiz->timemodified = time();
1052     // Quiz name.
1053     if (!empty($quiz->name)) {
1054         $quiz->name = trim($quiz->name);
1055     }
1057     // Password field - different in form to stop browsers that remember passwords
1058     // getting confused.
1059     $quiz->password = $quiz->quizpassword;
1060     unset($quiz->quizpassword);
1062     // Quiz feedback.
1063     if (isset($quiz->feedbacktext)) {
1064         // Clean up the boundary text.
1065         for ($i = 0; $i < count($quiz->feedbacktext); $i += 1) {
1066             if (empty($quiz->feedbacktext[$i]['text'])) {
1067                 $quiz->feedbacktext[$i]['text'] = '';
1068             } else {
1069                 $quiz->feedbacktext[$i]['text'] = trim($quiz->feedbacktext[$i]['text']);
1070             }
1071         }
1073         // Check the boundary value is a number or a percentage, and in range.
1074         $i = 0;
1075         while (!empty($quiz->feedbackboundaries[$i])) {
1076             $boundary = trim($quiz->feedbackboundaries[$i]);
1077             if (!is_numeric($boundary)) {
1078                 if (strlen($boundary) > 0 && $boundary[strlen($boundary) - 1] == '%') {
1079                     $boundary = trim(substr($boundary, 0, -1));
1080                     if (is_numeric($boundary)) {
1081                         $boundary = $boundary * $quiz->grade / 100.0;
1082                     } else {
1083                         return get_string('feedbackerrorboundaryformat', 'quiz', $i + 1);
1084                     }
1085                 }
1086             }
1087             if ($boundary <= 0 || $boundary >= $quiz->grade) {
1088                 return get_string('feedbackerrorboundaryoutofrange', 'quiz', $i + 1);
1089             }
1090             if ($i > 0 && $boundary >= $quiz->feedbackboundaries[$i - 1]) {
1091                 return get_string('feedbackerrororder', 'quiz', $i + 1);
1092             }
1093             $quiz->feedbackboundaries[$i] = $boundary;
1094             $i += 1;
1095         }
1096         $numboundaries = $i;
1098         // Check there is nothing in the remaining unused fields.
1099         if (!empty($quiz->feedbackboundaries)) {
1100             for ($i = $numboundaries; $i < count($quiz->feedbackboundaries); $i += 1) {
1101                 if (!empty($quiz->feedbackboundaries[$i]) &&
1102                         trim($quiz->feedbackboundaries[$i]) != '') {
1103                     return get_string('feedbackerrorjunkinboundary', 'quiz', $i + 1);
1104                 }
1105             }
1106         }
1107         for ($i = $numboundaries + 1; $i < count($quiz->feedbacktext); $i += 1) {
1108             if (!empty($quiz->feedbacktext[$i]['text']) &&
1109                     trim($quiz->feedbacktext[$i]['text']) != '') {
1110                 return get_string('feedbackerrorjunkinfeedback', 'quiz', $i + 1);
1111             }
1112         }
1113         // Needs to be bigger than $quiz->grade because of '<' test in quiz_feedback_for_grade().
1114         $quiz->feedbackboundaries[-1] = $quiz->grade + 1;
1115         $quiz->feedbackboundaries[$numboundaries] = 0;
1116         $quiz->feedbackboundarycount = $numboundaries;
1117     } else {
1118         $quiz->feedbackboundarycount = -1;
1119     }
1121     // Combing the individual settings into the review columns.
1122     $quiz->reviewattempt = quiz_review_option_form_to_db($quiz, 'attempt');
1123     $quiz->reviewcorrectness = quiz_review_option_form_to_db($quiz, 'correctness');
1124     $quiz->reviewmarks = quiz_review_option_form_to_db($quiz, 'marks');
1125     $quiz->reviewspecificfeedback = quiz_review_option_form_to_db($quiz, 'specificfeedback');
1126     $quiz->reviewgeneralfeedback = quiz_review_option_form_to_db($quiz, 'generalfeedback');
1127     $quiz->reviewrightanswer = quiz_review_option_form_to_db($quiz, 'rightanswer');
1128     $quiz->reviewoverallfeedback = quiz_review_option_form_to_db($quiz, 'overallfeedback');
1129     $quiz->reviewattempt |= mod_quiz_display_options::DURING;
1130     $quiz->reviewoverallfeedback &= ~mod_quiz_display_options::DURING;
1133 /**
1134  * Helper function for {@link quiz_process_options()}.
1135  * @param object $fromform the sumbitted form date.
1136  * @param string $field one of the review option field names.
1137  */
1138 function quiz_review_option_form_to_db($fromform, $field) {
1139     static $times = array(
1140         'during' => mod_quiz_display_options::DURING,
1141         'immediately' => mod_quiz_display_options::IMMEDIATELY_AFTER,
1142         'open' => mod_quiz_display_options::LATER_WHILE_OPEN,
1143         'closed' => mod_quiz_display_options::AFTER_CLOSE,
1144     );
1146     $review = 0;
1147     foreach ($times as $whenname => $when) {
1148         $fieldname = $field . $whenname;
1149         if (isset($fromform->$fieldname)) {
1150             $review |= $when;
1151             unset($fromform->$fieldname);
1152         }
1153     }
1155     return $review;
1158 /**
1159  * This function is called at the end of quiz_add_instance
1160  * and quiz_update_instance, to do the common processing.
1161  *
1162  * @param object $quiz the quiz object.
1163  */
1164 function quiz_after_add_or_update($quiz) {
1165     global $DB;
1166     $cmid = $quiz->coursemodule;
1168     // We need to use context now, so we need to make sure all needed info is already in db.
1169     $DB->set_field('course_modules', 'instance', $quiz->id, array('id'=>$cmid));
1170     $context = context_module::instance($cmid);
1172     // Save the feedback.
1173     $DB->delete_records('quiz_feedback', array('quizid' => $quiz->id));
1175     for ($i = 0; $i <= $quiz->feedbackboundarycount; $i++) {
1176         $feedback = new stdClass();
1177         $feedback->quizid = $quiz->id;
1178         $feedback->feedbacktext = $quiz->feedbacktext[$i]['text'];
1179         $feedback->feedbacktextformat = $quiz->feedbacktext[$i]['format'];
1180         $feedback->mingrade = $quiz->feedbackboundaries[$i];
1181         $feedback->maxgrade = $quiz->feedbackboundaries[$i - 1];
1182         $feedback->id = $DB->insert_record('quiz_feedback', $feedback);
1183         $feedbacktext = file_save_draft_area_files((int)$quiz->feedbacktext[$i]['itemid'],
1184                 $context->id, 'mod_quiz', 'feedback', $feedback->id,
1185                 array('subdirs' => false, 'maxfiles' => -1, 'maxbytes' => 0),
1186                 $quiz->feedbacktext[$i]['text']);
1187         $DB->set_field('quiz_feedback', 'feedbacktext', $feedbacktext,
1188                 array('id' => $feedback->id));
1189     }
1191     // Store any settings belonging to the access rules.
1192     quiz_access_manager::save_settings($quiz);
1194     // Update the events relating to this quiz.
1195     quiz_update_events($quiz);
1196     $completionexpected = (!empty($quiz->completionexpected)) ? $quiz->completionexpected : null;
1197     \core_completion\api::update_completion_date_event($quiz->coursemodule, 'quiz', $quiz->id, $completionexpected);
1199     // Update related grade item.
1200     quiz_grade_item_update($quiz);
1203 /**
1204  * This function updates the events associated to the quiz.
1205  * If $override is non-zero, then it updates only the events
1206  * associated with the specified override.
1207  *
1208  * @uses QUIZ_MAX_EVENT_LENGTH
1209  * @param object $quiz the quiz object.
1210  * @param object optional $override limit to a specific override
1211  */
1212 function quiz_update_events($quiz, $override = null) {
1213     global $DB;
1215     // Load the old events relating to this quiz.
1216     $conds = array('modulename'=>'quiz',
1217                    'instance'=>$quiz->id);
1218     if (!empty($override)) {
1219         // Only load events for this override.
1220         if (isset($override->userid)) {
1221             $conds['userid'] = $override->userid;
1222         } else {
1223             $conds['groupid'] = $override->groupid;
1224         }
1225     }
1226     $oldevents = $DB->get_records('event', $conds, 'id ASC');
1228     // Now make a to-do list of all that needs to be updated.
1229     if (empty($override)) {
1230         // We are updating the primary settings for the quiz, so we need to add all the overrides.
1231         $overrides = $DB->get_records('quiz_overrides', array('quiz' => $quiz->id), 'id ASC');
1232         // It is necessary to add an empty stdClass to the beginning of the array as the $oldevents
1233         // list contains the original (non-override) event for the module. If this is not included
1234         // the logic below will end up updating the wrong row when we try to reconcile this $overrides
1235         // list against the $oldevents list.
1236         array_unshift($overrides, new stdClass());
1237     } else {
1238         // Just do the one override.
1239         $overrides = array($override);
1240     }
1242     // Get group override priorities.
1243     $grouppriorities = quiz_get_group_override_priorities($quiz->id);
1245     foreach ($overrides as $current) {
1246         $groupid   = isset($current->groupid)?  $current->groupid : 0;
1247         $userid    = isset($current->userid)? $current->userid : 0;
1248         $timeopen  = isset($current->timeopen)?  $current->timeopen : $quiz->timeopen;
1249         $timeclose = isset($current->timeclose)? $current->timeclose : $quiz->timeclose;
1251         // Only add open/close events for an override if they differ from the quiz default.
1252         $addopen  = empty($current->id) || !empty($current->timeopen);
1253         $addclose = empty($current->id) || !empty($current->timeclose);
1255         if (!empty($quiz->coursemodule)) {
1256             $cmid = $quiz->coursemodule;
1257         } else {
1258             $cmid = get_coursemodule_from_instance('quiz', $quiz->id, $quiz->course)->id;
1259         }
1261         $event = new stdClass();
1262         $event->type = !$timeclose ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
1263         $event->description = format_module_intro('quiz', $quiz, $cmid);
1264         // Events module won't show user events when the courseid is nonzero.
1265         $event->courseid    = ($userid) ? 0 : $quiz->course;
1266         $event->groupid     = $groupid;
1267         $event->userid      = $userid;
1268         $event->modulename  = 'quiz';
1269         $event->instance    = $quiz->id;
1270         $event->timestart   = $timeopen;
1271         $event->timeduration = max($timeclose - $timeopen, 0);
1272         $event->timesort    = $timeopen;
1273         $event->visible     = instance_is_visible('quiz', $quiz);
1274         $event->eventtype   = QUIZ_EVENT_TYPE_OPEN;
1275         $event->priority    = null;
1277         // Determine the event name and priority.
1278         if ($groupid) {
1279             // Group override event.
1280             $params = new stdClass();
1281             $params->quiz = $quiz->name;
1282             $params->group = groups_get_group_name($groupid);
1283             if ($params->group === false) {
1284                 // Group doesn't exist, just skip it.
1285                 continue;
1286             }
1287             $eventname = get_string('overridegroupeventname', 'quiz', $params);
1288             // Set group override priority.
1289             if ($grouppriorities !== null) {
1290                 $openpriorities = $grouppriorities['open'];
1291                 if (isset($openpriorities[$timeopen])) {
1292                     $event->priority = $openpriorities[$timeopen];
1293                 }
1294             }
1295         } else if ($userid) {
1296             // User override event.
1297             $params = new stdClass();
1298             $params->quiz = $quiz->name;
1299             $eventname = get_string('overrideusereventname', 'quiz', $params);
1300             // Set user override priority.
1301             $event->priority = CALENDAR_EVENT_USER_OVERRIDE_PRIORITY;
1302         } else {
1303             // The parent event.
1304             $eventname = $quiz->name;
1305         }
1307         if ($addopen or $addclose) {
1308             // Separate start and end events.
1309             $event->timeduration  = 0;
1310             if ($timeopen && $addopen) {
1311                 if ($oldevent = array_shift($oldevents)) {
1312                     $event->id = $oldevent->id;
1313                 } else {
1314                     unset($event->id);
1315                 }
1316                 $event->name = get_string('quizeventopens', 'quiz', $eventname);
1317                 // The method calendar_event::create will reuse a db record if the id field is set.
1318                 calendar_event::create($event, false);
1319             }
1320             if ($timeclose && $addclose) {
1321                 if ($oldevent = array_shift($oldevents)) {
1322                     $event->id = $oldevent->id;
1323                 } else {
1324                     unset($event->id);
1325                 }
1326                 $event->type      = CALENDAR_EVENT_TYPE_ACTION;
1327                 $event->name      = get_string('quizeventcloses', 'quiz', $eventname);
1328                 $event->timestart = $timeclose;
1329                 $event->timesort  = $timeclose;
1330                 $event->eventtype = QUIZ_EVENT_TYPE_CLOSE;
1331                 if ($groupid && $grouppriorities !== null) {
1332                     $closepriorities = $grouppriorities['close'];
1333                     if (isset($closepriorities[$timeclose])) {
1334                         $event->priority = $closepriorities[$timeclose];
1335                     }
1336                 }
1337                 calendar_event::create($event, false);
1338             }
1339         }
1340     }
1342     // Delete any leftover events.
1343     foreach ($oldevents as $badevent) {
1344         $badevent = calendar_event::load($badevent);
1345         $badevent->delete();
1346     }
1349 /**
1350  * Calculates the priorities of timeopen and timeclose values for group overrides for a quiz.
1351  *
1352  * @param int $quizid The quiz ID.
1353  * @return array|null Array of group override priorities for open and close times. Null if there are no group overrides.
1354  */
1355 function quiz_get_group_override_priorities($quizid) {
1356     global $DB;
1358     // Fetch group overrides.
1359     $where = 'quiz = :quiz AND groupid IS NOT NULL';
1360     $params = ['quiz' => $quizid];
1361     $overrides = $DB->get_records_select('quiz_overrides', $where, $params, '', 'id, timeopen, timeclose');
1362     if (!$overrides) {
1363         return null;
1364     }
1366     $grouptimeopen = [];
1367     $grouptimeclose = [];
1368     foreach ($overrides as $override) {
1369         if ($override->timeopen !== null && !in_array($override->timeopen, $grouptimeopen)) {
1370             $grouptimeopen[] = $override->timeopen;
1371         }
1372         if ($override->timeclose !== null && !in_array($override->timeclose, $grouptimeclose)) {
1373             $grouptimeclose[] = $override->timeclose;
1374         }
1375     }
1377     // Sort open times in ascending manner. The earlier open time gets higher priority.
1378     sort($grouptimeopen);
1379     // Set priorities.
1380     $opengrouppriorities = [];
1381     $openpriority = 1;
1382     foreach ($grouptimeopen as $timeopen) {
1383         $opengrouppriorities[$timeopen] = $openpriority++;
1384     }
1386     // Sort close times in descending manner. The later close time gets higher priority.
1387     rsort($grouptimeclose);
1388     // Set priorities.
1389     $closegrouppriorities = [];
1390     $closepriority = 1;
1391     foreach ($grouptimeclose as $timeclose) {
1392         $closegrouppriorities[$timeclose] = $closepriority++;
1393     }
1395     return [
1396         'open' => $opengrouppriorities,
1397         'close' => $closegrouppriorities
1398     ];
1401 /**
1402  * List the actions that correspond to a view of this module.
1403  * This is used by the participation report.
1404  *
1405  * Note: This is not used by new logging system. Event with
1406  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1407  *       be considered as view action.
1408  *
1409  * @return array
1410  */
1411 function quiz_get_view_actions() {
1412     return array('view', 'view all', 'report', 'review');
1415 /**
1416  * List the actions that correspond to a post of this module.
1417  * This is used by the participation report.
1418  *
1419  * Note: This is not used by new logging system. Event with
1420  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1421  *       will be considered as post action.
1422  *
1423  * @return array
1424  */
1425 function quiz_get_post_actions() {
1426     return array('attempt', 'close attempt', 'preview', 'editquestions',
1427             'delete attempt', 'manualgrade');
1430 /**
1431  * @param array $questionids of question ids.
1432  * @return bool whether any of these questions are used by any instance of this module.
1433  */
1434 function quiz_questions_in_use($questionids) {
1435     global $DB, $CFG;
1436     require_once($CFG->libdir . '/questionlib.php');
1437     list($test, $params) = $DB->get_in_or_equal($questionids);
1438     return $DB->record_exists_select('quiz_slots',
1439             'questionid ' . $test, $params) || question_engine::questions_in_use(
1440             $questionids, new qubaid_join('{quiz_attempts} quiza',
1441             'quiza.uniqueid', 'quiza.preview = 0'));
1444 /**
1445  * Implementation of the function for printing the form elements that control
1446  * whether the course reset functionality affects the quiz.
1447  *
1448  * @param $mform the course reset form that is being built.
1449  */
1450 function quiz_reset_course_form_definition($mform) {
1451     $mform->addElement('header', 'quizheader', get_string('modulenameplural', 'quiz'));
1452     $mform->addElement('advcheckbox', 'reset_quiz_attempts',
1453             get_string('removeallquizattempts', 'quiz'));
1454     $mform->addElement('advcheckbox', 'reset_quiz_user_overrides',
1455             get_string('removealluseroverrides', 'quiz'));
1456     $mform->addElement('advcheckbox', 'reset_quiz_group_overrides',
1457             get_string('removeallgroupoverrides', 'quiz'));
1460 /**
1461  * Course reset form defaults.
1462  * @return array the defaults.
1463  */
1464 function quiz_reset_course_form_defaults($course) {
1465     return array('reset_quiz_attempts' => 1,
1466                  'reset_quiz_group_overrides' => 1,
1467                  'reset_quiz_user_overrides' => 1);
1470 /**
1471  * Removes all grades from gradebook
1472  *
1473  * @param int $courseid
1474  * @param string optional type
1475  */
1476 function quiz_reset_gradebook($courseid, $type='') {
1477     global $CFG, $DB;
1479     $quizzes = $DB->get_records_sql("
1480             SELECT q.*, cm.idnumber as cmidnumber, q.course as courseid
1481             FROM {modules} m
1482             JOIN {course_modules} cm ON m.id = cm.module
1483             JOIN {quiz} q ON cm.instance = q.id
1484             WHERE m.name = 'quiz' AND cm.course = ?", array($courseid));
1486     foreach ($quizzes as $quiz) {
1487         quiz_grade_item_update($quiz, 'reset');
1488     }
1491 /**
1492  * Actual implementation of the reset course functionality, delete all the
1493  * quiz attempts for course $data->courseid, if $data->reset_quiz_attempts is
1494  * set and true.
1495  *
1496  * Also, move the quiz open and close dates, if the course start date is changing.
1497  *
1498  * @param object $data the data submitted from the reset course.
1499  * @return array status array
1500  */
1501 function quiz_reset_userdata($data) {
1502     global $CFG, $DB;
1503     require_once($CFG->libdir . '/questionlib.php');
1505     $componentstr = get_string('modulenameplural', 'quiz');
1506     $status = array();
1508     // Delete attempts.
1509     if (!empty($data->reset_quiz_attempts)) {
1510         question_engine::delete_questions_usage_by_activities(new qubaid_join(
1511                 '{quiz_attempts} quiza JOIN {quiz} quiz ON quiza.quiz = quiz.id',
1512                 'quiza.uniqueid', 'quiz.course = :quizcourseid',
1513                 array('quizcourseid' => $data->courseid)));
1515         $DB->delete_records_select('quiz_attempts',
1516                 'quiz IN (SELECT id FROM {quiz} WHERE course = ?)', array($data->courseid));
1517         $status[] = array(
1518             'component' => $componentstr,
1519             'item' => get_string('attemptsdeleted', 'quiz'),
1520             'error' => false);
1522         // Remove all grades from gradebook.
1523         $DB->delete_records_select('quiz_grades',
1524                 'quiz IN (SELECT id FROM {quiz} WHERE course = ?)', array($data->courseid));
1525         if (empty($data->reset_gradebook_grades)) {
1526             quiz_reset_gradebook($data->courseid);
1527         }
1528         $status[] = array(
1529             'component' => $componentstr,
1530             'item' => get_string('gradesdeleted', 'quiz'),
1531             'error' => false);
1532     }
1534     // Remove user overrides.
1535     if (!empty($data->reset_quiz_user_overrides)) {
1536         $DB->delete_records_select('quiz_overrides',
1537                 'quiz IN (SELECT id FROM {quiz} WHERE course = ?) AND userid IS NOT NULL', array($data->courseid));
1538         $status[] = array(
1539             'component' => $componentstr,
1540             'item' => get_string('useroverridesdeleted', 'quiz'),
1541             'error' => false);
1542     }
1543     // Remove group overrides.
1544     if (!empty($data->reset_quiz_group_overrides)) {
1545         $DB->delete_records_select('quiz_overrides',
1546                 'quiz IN (SELECT id FROM {quiz} WHERE course = ?) AND groupid IS NOT NULL', array($data->courseid));
1547         $status[] = array(
1548             'component' => $componentstr,
1549             'item' => get_string('groupoverridesdeleted', 'quiz'),
1550             'error' => false);
1551     }
1553     // Updating dates - shift may be negative too.
1554     if ($data->timeshift) {
1555         $DB->execute("UPDATE {quiz_overrides}
1556                          SET timeopen = timeopen + ?
1557                        WHERE quiz IN (SELECT id FROM {quiz} WHERE course = ?)
1558                          AND timeopen <> 0", array($data->timeshift, $data->courseid));
1559         $DB->execute("UPDATE {quiz_overrides}
1560                          SET timeclose = timeclose + ?
1561                        WHERE quiz IN (SELECT id FROM {quiz} WHERE course = ?)
1562                          AND timeclose <> 0", array($data->timeshift, $data->courseid));
1564         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
1565         // See MDL-9367.
1566         shift_course_mod_dates('quiz', array('timeopen', 'timeclose'),
1567                 $data->timeshift, $data->courseid);
1569         $status[] = array(
1570             'component' => $componentstr,
1571             'item' => get_string('openclosedatesupdated', 'quiz'),
1572             'error' => false);
1573     }
1575     return $status;
1578 /**
1579  * Prints quiz summaries on MyMoodle Page
1580  *
1581  * @deprecated since 3.3
1582  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
1583  * @param array $courses
1584  * @param array $htmlarray
1585  */
1586 function quiz_print_overview($courses, &$htmlarray) {
1587     global $USER, $CFG;
1589     debugging('The function quiz_print_overview() is now deprecated.', DEBUG_DEVELOPER);
1591     // These next 6 Lines are constant in all modules (just change module name).
1592     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1593         return array();
1594     }
1596     if (!$quizzes = get_all_instances_in_courses('quiz', $courses)) {
1597         return;
1598     }
1600     // Get the quizzes attempts.
1601     $attemptsinfo = [];
1602     $quizids = [];
1603     foreach ($quizzes as $quiz) {
1604         $quizids[] = $quiz->id;
1605         $attemptsinfo[$quiz->id] = ['count' => 0, 'hasfinished' => false];
1606     }
1607     $attempts = quiz_get_user_attempts($quizids, $USER->id);
1608     foreach ($attempts as $attempt) {
1609         $attemptsinfo[$attempt->quiz]['count']++;
1610         $attemptsinfo[$attempt->quiz]['hasfinished'] = true;
1611     }
1612     unset($attempts);
1614     // Fetch some language strings outside the main loop.
1615     $strquiz = get_string('modulename', 'quiz');
1616     $strnoattempts = get_string('noattempts', 'quiz');
1618     // We want to list quizzes that are currently available, and which have a close date.
1619     // This is the same as what the lesson does, and the dabate is in MDL-10568.
1620     $now = time();
1621     foreach ($quizzes as $quiz) {
1622         if ($quiz->timeclose >= $now && $quiz->timeopen < $now) {
1623             $str = '';
1625             // Now provide more information depending on the uers's role.
1626             $context = context_module::instance($quiz->coursemodule);
1627             if (has_capability('mod/quiz:viewreports', $context)) {
1628                 // For teacher-like people, show a summary of the number of student attempts.
1629                 // The $quiz objects returned by get_all_instances_in_course have the necessary $cm
1630                 // fields set to make the following call work.
1631                 $str .= '<div class="info">' . quiz_num_attempt_summary($quiz, $quiz, true) . '</div>';
1633             } else if (has_any_capability(array('mod/quiz:reviewmyattempts', 'mod/quiz:attempt'), $context)) { // Student
1634                 // For student-like people, tell them how many attempts they have made.
1636                 if (isset($USER->id)) {
1637                     if ($attemptsinfo[$quiz->id]['hasfinished']) {
1638                         // The student's last attempt is finished.
1639                         continue;
1640                     }
1642                     if ($attemptsinfo[$quiz->id]['count'] > 0) {
1643                         $str .= '<div class="info">' .
1644                             get_string('numattemptsmade', 'quiz', $attemptsinfo[$quiz->id]['count']) . '</div>';
1645                     } else {
1646                         $str .= '<div class="info">' . $strnoattempts . '</div>';
1647                     }
1649                 } else {
1650                     $str .= '<div class="info">' . $strnoattempts . '</div>';
1651                 }
1653             } else {
1654                 // For ayone else, there is no point listing this quiz, so stop processing.
1655                 continue;
1656             }
1658             // Give a link to the quiz, and the deadline.
1659             $html = '<div class="quiz overview">' .
1660                     '<div class="name">' . $strquiz . ': <a ' .
1661                     ($quiz->visible ? '' : ' class="dimmed"') .
1662                     ' href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' .
1663                     $quiz->coursemodule . '">' .
1664                     $quiz->name . '</a></div>';
1665             $html .= '<div class="info">' . get_string('quizcloseson', 'quiz',
1666                     userdate($quiz->timeclose)) . '</div>';
1667             $html .= $str;
1668             $html .= '</div>';
1669             if (empty($htmlarray[$quiz->course]['quiz'])) {
1670                 $htmlarray[$quiz->course]['quiz'] = $html;
1671             } else {
1672                 $htmlarray[$quiz->course]['quiz'] .= $html;
1673             }
1674         }
1675     }
1678 /**
1679  * Return a textual summary of the number of attempts that have been made at a particular quiz,
1680  * returns '' if no attempts have been made yet, unless $returnzero is passed as true.
1681  *
1682  * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
1683  * @param object $cm the cm object. Only $cm->course, $cm->groupmode and
1684  *      $cm->groupingid fields are used at the moment.
1685  * @param bool $returnzero if false (default), when no attempts have been
1686  *      made '' is returned instead of 'Attempts: 0'.
1687  * @param int $currentgroup if there is a concept of current group where this method is being called
1688  *         (e.g. a report) pass it in here. Default 0 which means no current group.
1689  * @return string a string like "Attempts: 123", "Attemtps 123 (45 from your groups)" or
1690  *          "Attemtps 123 (45 from this group)".
1691  */
1692 function quiz_num_attempt_summary($quiz, $cm, $returnzero = false, $currentgroup = 0) {
1693     global $DB, $USER;
1694     $numattempts = $DB->count_records('quiz_attempts', array('quiz'=> $quiz->id, 'preview'=>0));
1695     if ($numattempts || $returnzero) {
1696         if (groups_get_activity_groupmode($cm)) {
1697             $a = new stdClass();
1698             $a->total = $numattempts;
1699             if ($currentgroup) {
1700                 $a->group = $DB->count_records_sql('SELECT COUNT(DISTINCT qa.id) FROM ' .
1701                         '{quiz_attempts} qa JOIN ' .
1702                         '{groups_members} gm ON qa.userid = gm.userid ' .
1703                         'WHERE quiz = ? AND preview = 0 AND groupid = ?',
1704                         array($quiz->id, $currentgroup));
1705                 return get_string('attemptsnumthisgroup', 'quiz', $a);
1706             } else if ($groups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid)) {
1707                 list($usql, $params) = $DB->get_in_or_equal(array_keys($groups));
1708                 $a->group = $DB->count_records_sql('SELECT COUNT(DISTINCT qa.id) FROM ' .
1709                         '{quiz_attempts} qa JOIN ' .
1710                         '{groups_members} gm ON qa.userid = gm.userid ' .
1711                         'WHERE quiz = ? AND preview = 0 AND ' .
1712                         "groupid $usql", array_merge(array($quiz->id), $params));
1713                 return get_string('attemptsnumyourgroups', 'quiz', $a);
1714             }
1715         }
1716         return get_string('attemptsnum', 'quiz', $numattempts);
1717     }
1718     return '';
1721 /**
1722  * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link
1723  * to the quiz reports.
1724  *
1725  * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
1726  * @param object $cm the cm object. Only $cm->course, $cm->groupmode and
1727  *      $cm->groupingid fields are used at the moment.
1728  * @param object $context the quiz context.
1729  * @param bool $returnzero if false (default), when no attempts have been made
1730  *      '' is returned instead of 'Attempts: 0'.
1731  * @param int $currentgroup if there is a concept of current group where this method is being called
1732  *         (e.g. a report) pass it in here. Default 0 which means no current group.
1733  * @return string HTML fragment for the link.
1734  */
1735 function quiz_attempt_summary_link_to_reports($quiz, $cm, $context, $returnzero = false,
1736         $currentgroup = 0) {
1737     global $CFG;
1738     $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup);
1739     if (!$summary) {
1740         return '';
1741     }
1743     require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
1744     $url = new moodle_url('/mod/quiz/report.php', array(
1745             'id' => $cm->id, 'mode' => quiz_report_default_report($context)));
1746     return html_writer::link($url, $summary);
1749 /**
1750  * @param string $feature FEATURE_xx constant for requested feature
1751  * @return bool True if quiz supports feature
1752  */
1753 function quiz_supports($feature) {
1754     switch($feature) {
1755         case FEATURE_GROUPS:                    return true;
1756         case FEATURE_GROUPINGS:                 return true;
1757         case FEATURE_MOD_INTRO:                 return true;
1758         case FEATURE_COMPLETION_TRACKS_VIEWS:   return true;
1759         case FEATURE_COMPLETION_HAS_RULES:      return true;
1760         case FEATURE_GRADE_HAS_GRADE:           return true;
1761         case FEATURE_GRADE_OUTCOMES:            return true;
1762         case FEATURE_BACKUP_MOODLE2:            return true;
1763         case FEATURE_SHOW_DESCRIPTION:          return true;
1764         case FEATURE_CONTROLS_GRADE_VISIBILITY: return true;
1765         case FEATURE_USES_QUESTIONS:            return true;
1767         default: return null;
1768     }
1771 /**
1772  * @return array all other caps used in module
1773  */
1774 function quiz_get_extra_capabilities() {
1775     global $CFG;
1776     require_once($CFG->libdir . '/questionlib.php');
1777     return question_get_all_capabilities();
1780 /**
1781  * This function extends the settings navigation block for the site.
1782  *
1783  * It is safe to rely on PAGE here as we will only ever be within the module
1784  * context when this is called
1785  *
1786  * @param settings_navigation $settings
1787  * @param navigation_node $quiznode
1788  * @return void
1789  */
1790 function quiz_extend_settings_navigation($settings, $quiznode) {
1791     global $PAGE, $CFG;
1793     // Require {@link questionlib.php}
1794     // Included here as we only ever want to include this file if we really need to.
1795     require_once($CFG->libdir . '/questionlib.php');
1797     // We want to add these new nodes after the Edit settings node, and before the
1798     // Locally assigned roles node. Of course, both of those are controlled by capabilities.
1799     $keys = $quiznode->get_children_key_list();
1800     $beforekey = null;
1801     $i = array_search('modedit', $keys);
1802     if ($i === false and array_key_exists(0, $keys)) {
1803         $beforekey = $keys[0];
1804     } else if (array_key_exists($i + 1, $keys)) {
1805         $beforekey = $keys[$i + 1];
1806     }
1808     if (has_capability('mod/quiz:manageoverrides', $PAGE->cm->context)) {
1809         $url = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$PAGE->cm->id));
1810         $node = navigation_node::create(get_string('groupoverrides', 'quiz'),
1811                 new moodle_url($url, array('mode'=>'group')),
1812                 navigation_node::TYPE_SETTING, null, 'mod_quiz_groupoverrides');
1813         $quiznode->add_node($node, $beforekey);
1815         $node = navigation_node::create(get_string('useroverrides', 'quiz'),
1816                 new moodle_url($url, array('mode'=>'user')),
1817                 navigation_node::TYPE_SETTING, null, 'mod_quiz_useroverrides');
1818         $quiznode->add_node($node, $beforekey);
1819     }
1821     if (has_capability('mod/quiz:manage', $PAGE->cm->context)) {
1822         $node = navigation_node::create(get_string('editquiz', 'quiz'),
1823                 new moodle_url('/mod/quiz/edit.php', array('cmid'=>$PAGE->cm->id)),
1824                 navigation_node::TYPE_SETTING, null, 'mod_quiz_edit',
1825                 new pix_icon('t/edit', ''));
1826         $quiznode->add_node($node, $beforekey);
1827     }
1829     if (has_capability('mod/quiz:preview', $PAGE->cm->context)) {
1830         $url = new moodle_url('/mod/quiz/startattempt.php',
1831                 array('cmid'=>$PAGE->cm->id, 'sesskey'=>sesskey()));
1832         $node = navigation_node::create(get_string('preview', 'quiz'), $url,
1833                 navigation_node::TYPE_SETTING, null, 'mod_quiz_preview',
1834                 new pix_icon('i/preview', ''));
1835         $quiznode->add_node($node, $beforekey);
1836     }
1838     if (has_any_capability(array('mod/quiz:viewreports', 'mod/quiz:grade'), $PAGE->cm->context)) {
1839         require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
1840         $reportlist = quiz_report_list($PAGE->cm->context);
1842         $url = new moodle_url('/mod/quiz/report.php',
1843                 array('id' => $PAGE->cm->id, 'mode' => reset($reportlist)));
1844         $reportnode = $quiznode->add_node(navigation_node::create(get_string('results', 'quiz'), $url,
1845                 navigation_node::TYPE_SETTING,
1846                 null, null, new pix_icon('i/report', '')), $beforekey);
1848         foreach ($reportlist as $report) {
1849             $url = new moodle_url('/mod/quiz/report.php',
1850                     array('id' => $PAGE->cm->id, 'mode' => $report));
1851             $reportnode->add_node(navigation_node::create(get_string($report, 'quiz_'.$report), $url,
1852                     navigation_node::TYPE_SETTING,
1853                     null, 'quiz_report_' . $report, new pix_icon('i/item', '')));
1854         }
1855     }
1857     question_extend_settings_navigation($quiznode, $PAGE->cm->context)->trim_if_empty();
1860 /**
1861  * Serves the quiz files.
1862  *
1863  * @package  mod_quiz
1864  * @category files
1865  * @param stdClass $course course object
1866  * @param stdClass $cm course module object
1867  * @param stdClass $context context object
1868  * @param string $filearea file area
1869  * @param array $args extra arguments
1870  * @param bool $forcedownload whether or not force download
1871  * @param array $options additional options affecting the file serving
1872  * @return bool false if file not found, does not return if found - justsend the file
1873  */
1874 function quiz_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
1875     global $CFG, $DB;
1877     if ($context->contextlevel != CONTEXT_MODULE) {
1878         return false;
1879     }
1881     require_login($course, false, $cm);
1883     if (!$quiz = $DB->get_record('quiz', array('id'=>$cm->instance))) {
1884         return false;
1885     }
1887     // The 'intro' area is served by pluginfile.php.
1888     $fileareas = array('feedback');
1889     if (!in_array($filearea, $fileareas)) {
1890         return false;
1891     }
1893     $feedbackid = (int)array_shift($args);
1894     if (!$feedback = $DB->get_record('quiz_feedback', array('id'=>$feedbackid))) {
1895         return false;
1896     }
1898     $fs = get_file_storage();
1899     $relativepath = implode('/', $args);
1900     $fullpath = "/$context->id/mod_quiz/$filearea/$feedbackid/$relativepath";
1901     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1902         return false;
1903     }
1904     send_stored_file($file, 0, 0, true, $options);
1907 /**
1908  * Called via pluginfile.php -> question_pluginfile to serve files belonging to
1909  * a question in a question_attempt when that attempt is a quiz attempt.
1910  *
1911  * @package  mod_quiz
1912  * @category files
1913  * @param stdClass $course course settings object
1914  * @param stdClass $context context object
1915  * @param string $component the name of the component we are serving files for.
1916  * @param string $filearea the name of the file area.
1917  * @param int $qubaid the attempt usage id.
1918  * @param int $slot the id of a question in this quiz attempt.
1919  * @param array $args the remaining bits of the file path.
1920  * @param bool $forcedownload whether the user must be forced to download the file.
1921  * @param array $options additional options affecting the file serving
1922  * @return bool false if file not found, does not return if found - justsend the file
1923  */
1924 function quiz_question_pluginfile($course, $context, $component,
1925         $filearea, $qubaid, $slot, $args, $forcedownload, array $options=array()) {
1926     global $CFG;
1927     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
1929     $attemptobj = quiz_attempt::create_from_usage_id($qubaid);
1930     require_login($attemptobj->get_course(), false, $attemptobj->get_cm());
1932     if ($attemptobj->is_own_attempt() && !$attemptobj->is_finished()) {
1933         // In the middle of an attempt.
1934         if (!$attemptobj->is_preview_user()) {
1935             $attemptobj->require_capability('mod/quiz:attempt');
1936         }
1937         $isreviewing = false;
1939     } else {
1940         // Reviewing an attempt.
1941         $attemptobj->check_review_capability();
1942         $isreviewing = true;
1943     }
1945     if (!$attemptobj->check_file_access($slot, $isreviewing, $context->id,
1946             $component, $filearea, $args, $forcedownload)) {
1947         send_file_not_found();
1948     }
1950     $fs = get_file_storage();
1951     $relativepath = implode('/', $args);
1952     $fullpath = "/$context->id/$component/$filearea/$relativepath";
1953     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1954         send_file_not_found();
1955     }
1957     send_stored_file($file, 0, 0, $forcedownload, $options);
1960 /**
1961  * Return a list of page types
1962  * @param string $pagetype current page type
1963  * @param stdClass $parentcontext Block's parent context
1964  * @param stdClass $currentcontext Current context of block
1965  */
1966 function quiz_page_type_list($pagetype, $parentcontext, $currentcontext) {
1967     $module_pagetype = array(
1968         'mod-quiz-*'       => get_string('page-mod-quiz-x', 'quiz'),
1969         'mod-quiz-view'    => get_string('page-mod-quiz-view', 'quiz'),
1970         'mod-quiz-attempt' => get_string('page-mod-quiz-attempt', 'quiz'),
1971         'mod-quiz-summary' => get_string('page-mod-quiz-summary', 'quiz'),
1972         'mod-quiz-review'  => get_string('page-mod-quiz-review', 'quiz'),
1973         'mod-quiz-edit'    => get_string('page-mod-quiz-edit', 'quiz'),
1974         'mod-quiz-report'  => get_string('page-mod-quiz-report', 'quiz'),
1975     );
1976     return $module_pagetype;
1979 /**
1980  * @return the options for quiz navigation.
1981  */
1982 function quiz_get_navigation_options() {
1983     return array(
1984         QUIZ_NAVMETHOD_FREE => get_string('navmethod_free', 'quiz'),
1985         QUIZ_NAVMETHOD_SEQ  => get_string('navmethod_seq', 'quiz')
1986     );
1989 /**
1990  * Obtains the automatic completion state for this quiz on any conditions
1991  * in quiz settings, such as if all attempts are used or a certain grade is achieved.
1992  *
1993  * @param object $course Course
1994  * @param object $cm Course-module
1995  * @param int $userid User ID
1996  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1997  * @return bool True if completed, false if not. (If no conditions, then return
1998  *   value depends on comparison type)
1999  */
2000 function quiz_get_completion_state($course, $cm, $userid, $type) {
2001     global $DB;
2002     global $CFG;
2004     $quiz = $DB->get_record('quiz', array('id' => $cm->instance), '*', MUST_EXIST);
2005     if (!$quiz->completionattemptsexhausted && !$quiz->completionpass) {
2006         return $type;
2007     }
2009     // Check if the user has used up all attempts.
2010     if ($quiz->completionattemptsexhausted) {
2011         $attempts = quiz_get_user_attempts($quiz->id, $userid, 'finished', true);
2012         if ($attempts) {
2013             $lastfinishedattempt = end($attempts);
2014             $context = context_module::instance($cm->id);
2015             $quizobj = quiz::create($quiz->id, $userid);
2016             $accessmanager = new quiz_access_manager($quizobj, time(),
2017                     has_capability('mod/quiz:ignoretimelimits', $context, $userid, false));
2018             if ($accessmanager->is_finished(count($attempts), $lastfinishedattempt)) {
2019                 return true;
2020             }
2021         }
2022     }
2024     // Check for passing grade.
2025     if ($quiz->completionpass) {
2026         require_once($CFG->libdir . '/gradelib.php');
2027         $item = grade_item::fetch(array('courseid' => $course->id, 'itemtype' => 'mod',
2028                 'itemmodule' => 'quiz', 'iteminstance' => $cm->instance, 'outcomeid' => null));
2029         if ($item) {
2030             $grades = grade_grade::fetch_users_grades($item, array($userid), false);
2031             if (!empty($grades[$userid])) {
2032                 return $grades[$userid]->is_passed($item);
2033             }
2034         }
2035     }
2036     return false;
2039 /**
2040  * Check if the module has any update that affects the current user since a given time.
2041  *
2042  * @param  cm_info $cm course module data
2043  * @param  int $from the time to check updates from
2044  * @param  array $filter  if we need to check only specific updates
2045  * @return stdClass an object with the different type of areas indicating if they were updated or not
2046  * @since Moodle 3.2
2047  */
2048 function quiz_check_updates_since(cm_info $cm, $from, $filter = array()) {
2049     global $DB, $USER, $CFG;
2050     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
2052     $updates = course_check_module_updates_since($cm, $from, array(), $filter);
2054     // Check if questions were updated.
2055     $updates->questions = (object) array('updated' => false);
2056     $quizobj = quiz::create($cm->instance, $USER->id);
2057     $quizobj->preload_questions();
2058     $quizobj->load_questions();
2059     $questionids = array_keys($quizobj->get_questions());
2060     if (!empty($questionids)) {
2061         list($questionsql, $params) = $DB->get_in_or_equal($questionids, SQL_PARAMS_NAMED);
2062         $select = 'id ' . $questionsql . ' AND (timemodified > :time1 OR timecreated > :time2)';
2063         $params['time1'] = $from;
2064         $params['time2'] = $from;
2065         $questions = $DB->get_records_select('question', $select, $params, '', 'id');
2066         if (!empty($questions)) {
2067             $updates->questions->updated = true;
2068             $updates->questions->itemids = array_keys($questions);
2069         }
2070     }
2072     // Check for new attempts or grades.
2073     $updates->attempts = (object) array('updated' => false);
2074     $updates->grades = (object) array('updated' => false);
2075     $select = 'quiz = ? AND userid = ? AND timemodified > ?';
2076     $params = array($cm->instance, $USER->id, $from);
2078     $attempts = $DB->get_records_select('quiz_attempts', $select, $params, '', 'id');
2079     if (!empty($attempts)) {
2080         $updates->attempts->updated = true;
2081         $updates->attempts->itemids = array_keys($attempts);
2082     }
2083     $grades = $DB->get_records_select('quiz_grades', $select, $params, '', 'id');
2084     if (!empty($grades)) {
2085         $updates->grades->updated = true;
2086         $updates->grades->itemids = array_keys($grades);
2087     }
2089     // Now, teachers should see other students updates.
2090     if (has_capability('mod/quiz:viewreports', $cm->context)) {
2091         $select = 'quiz = ? AND timemodified > ?';
2092         $params = array($cm->instance, $from);
2094         if (groups_get_activity_groupmode($cm) == SEPARATEGROUPS) {
2095             $groupusers = array_keys(groups_get_activity_shared_group_members($cm));
2096             if (empty($groupusers)) {
2097                 return $updates;
2098             }
2099             list($insql, $inparams) = $DB->get_in_or_equal($groupusers);
2100             $select .= ' AND userid ' . $insql;
2101             $params = array_merge($params, $inparams);
2102         }
2104         $updates->userattempts = (object) array('updated' => false);
2105         $attempts = $DB->get_records_select('quiz_attempts', $select, $params, '', 'id');
2106         if (!empty($attempts)) {
2107             $updates->userattempts->updated = true;
2108             $updates->userattempts->itemids = array_keys($attempts);
2109         }
2111         $updates->usergrades = (object) array('updated' => false);
2112         $grades = $DB->get_records_select('quiz_grades', $select, $params, '', 'id');
2113         if (!empty($grades)) {
2114             $updates->usergrades->updated = true;
2115             $updates->usergrades->itemids = array_keys($grades);
2116         }
2117     }
2118     return $updates;
2121 /**
2122  * Get icon mapping for font-awesome.
2123  */
2124 function mod_quiz_get_fontawesome_icon_map() {
2125     return [
2126         'mod_quiz:navflagged' => 'fa-flag',
2127     ];
2130 /**
2131  * This function receives a calendar event and returns the action associated with it, or null if there is none.
2132  *
2133  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
2134  * is not displayed on the block.
2135  *
2136  * @param calendar_event $event
2137  * @param \core_calendar\action_factory $factory
2138  * @return \core_calendar\local\event\entities\action_interface|null
2139  */
2140 function mod_quiz_core_calendar_provide_event_action(calendar_event $event,
2141                                                      \core_calendar\action_factory $factory) {
2142     global $CFG, $USER;
2144     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
2146     $cm = get_fast_modinfo($event->courseid)->instances['quiz'][$event->instance];
2147     $quizobj = quiz::create($cm->instance, $USER->id);
2148     $quiz = $quizobj->get_quiz();
2150     // Check they have capabilities allowing them to view the quiz.
2151     if (!has_any_capability(array('mod/quiz:reviewmyattempts', 'mod/quiz:attempt'), $quizobj->get_context())) {
2152         return null;
2153     }
2155     quiz_update_effective_access($quiz, $USER->id);
2157     // Check if quiz is closed, if so don't display it.
2158     if (!empty($quiz->timeclose) && $quiz->timeclose <= time()) {
2159         return null;
2160     }
2162     if (!$quizobj->is_participant($USER->id)) {
2163         // If the user is not a participant then they have
2164         // no action to take. This will filter out the events for teachers.
2165         return null;
2166     }
2168     $attempts = quiz_get_user_attempts($quizobj->get_quizid(), $USER->id);
2169     if (!empty($attempts)) {
2170         // The student's last attempt is finished.
2171         return null;
2172     }
2174     $name = get_string('attemptquiznow', 'quiz');
2175     $url = new \moodle_url('/mod/quiz/view.php', [
2176         'id' => $cm->id
2177     ]);
2178     $itemcount = 1;
2179     $actionable = true;
2181     // Check if the quiz is not currently actionable.
2182     if (!empty($quiz->timeopen) && $quiz->timeopen > time()) {
2183         $actionable = false;
2184     }
2186     return $factory->create_instance(
2187         $name,
2188         $url,
2189         $itemcount,
2190         $actionable
2191     );
2194 /**
2195  * Add a get_coursemodule_info function in case any quiz type wants to add 'extra' information
2196  * for the course (see resource).
2197  *
2198  * Given a course_module object, this function returns any "extra" information that may be needed
2199  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
2200  *
2201  * @param stdClass $coursemodule The coursemodule object (record).
2202  * @return cached_cm_info An object on information that the courses
2203  *                        will know about (most noticeably, an icon).
2204  */
2205 function quiz_get_coursemodule_info($coursemodule) {
2206     global $DB;
2208     $dbparams = ['id' => $coursemodule->instance];
2209     $fields = 'id, name, intro, introformat, completionattemptsexhausted, completionpass';
2210     if (!$quiz = $DB->get_record('quiz', $dbparams, $fields)) {
2211         return false;
2212     }
2214     $result = new cached_cm_info();
2215     $result->name = $quiz->name;
2217     if ($coursemodule->showdescription) {
2218         // Convert intro to html. Do not filter cached version, filters run at display time.
2219         $result->content = format_module_intro('quiz', $quiz, $coursemodule->id, false);
2220     }
2222     // Populate the custom completion rules as key => value pairs, but only if the completion mode is 'automatic'.
2223     if ($coursemodule->completion == COMPLETION_TRACKING_AUTOMATIC) {
2224         $result->customdata['customcompletionrules']['completionattemptsexhausted'] = $quiz->completionattemptsexhausted;
2225         $result->customdata['customcompletionrules']['completionpass'] = $quiz->completionpass;
2226     }
2228     return $result;
2231 /**
2232  * Callback which returns human-readable strings describing the active completion custom rules for the module instance.
2233  *
2234  * @param cm_info|stdClass $cm object with fields ->completion and ->customdata['customcompletionrules']
2235  * @return array $descriptions the array of descriptions for the custom rules.
2236  */
2237 function mod_quiz_get_completion_active_rule_descriptions($cm) {
2238     // Values will be present in cm_info, and we assume these are up to date.
2239     if (empty($cm->customdata['customcompletionrules'])
2240         || $cm->completion != COMPLETION_TRACKING_AUTOMATIC) {
2241         return [];
2242     }
2244     $descriptions = [];
2245     foreach ($cm->customdata['customcompletionrules'] as $key => $val) {
2246         switch ($key) {
2247             case 'completionattemptsexhausted':
2248                 if (!empty($val)) {
2249                     $descriptions[] = get_string('completionattemptsexhausteddesc', 'quiz');
2250                 }
2251                 break;
2252             case 'completionpass':
2253                 if (!empty($val)) {
2254                     $descriptions[] = get_string('completionpassdesc', 'quiz', format_time($val));
2255                 }
2256                 break;
2257             default:
2258                 break;
2259         }
2260     }
2261     return $descriptions;
2264 /**
2265  * Returns the min and max values for the timestart property of a quiz
2266  * activity event.
2267  *
2268  * The min and max values will be the timeopen and timeclose properties
2269  * of the quiz, respectively, if they are set.
2270  *
2271  * If either value isn't set then null will be returned instead to
2272  * indicate that there is no cutoff for that value.
2273  *
2274  * If the vent has no valid timestart range then [false, false] will
2275  * be returned. This is the case for overriden events.
2276  *
2277  * A minimum and maximum cutoff return value will look like:
2278  * [
2279  *     [1505704373, 'The date must be after this date'],
2280  *     [1506741172, 'The date must be before this date']
2281  * ]
2282  *
2283  * @throws \moodle_exception
2284  * @param \calendar_event $event The calendar event to get the time range for
2285  * @param stdClass $quiz The module instance to get the range from
2286  * @return array
2287  */
2288 function mod_quiz_core_calendar_get_valid_event_timestart_range(\calendar_event $event, \stdClass $quiz) {
2289     global $CFG, $DB;
2290     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
2292     // Overrides do not have a valid timestart range.
2293     if (quiz_is_overriden_calendar_event($event)) {
2294         return [false, false];
2295     }
2297     $mindate = null;
2298     $maxdate = null;
2300     if ($event->eventtype == QUIZ_EVENT_TYPE_OPEN) {
2301         if (!empty($quiz->timeclose)) {
2302             $maxdate = [
2303                 $quiz->timeclose,
2304                 get_string('openafterclose', 'quiz')
2305             ];
2306         }
2307     } else if ($event->eventtype == QUIZ_EVENT_TYPE_CLOSE) {
2308         if (!empty($quiz->timeopen)) {
2309             $mindate = [
2310                 $quiz->timeopen,
2311                 get_string('closebeforeopen', 'quiz')
2312             ];
2313         }
2314     }
2316     return [$mindate, $maxdate];
2319 /**
2320  * This function will update the quiz module according to the
2321  * event that has been modified.
2322  *
2323  * It will set the timeopen or timeclose value of the quiz instance
2324  * according to the type of event provided.
2325  *
2326  * @throws \moodle_exception
2327  * @param \calendar_event $event A quiz activity calendar event
2328  * @param \stdClass $quiz A quiz activity instance
2329  */
2330 function mod_quiz_core_calendar_event_timestart_updated(\calendar_event $event, \stdClass $quiz) {
2331     global $CFG, $DB;
2332     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
2334     if (!in_array($event->eventtype, [QUIZ_EVENT_TYPE_OPEN, QUIZ_EVENT_TYPE_CLOSE])) {
2335         // This isn't an event that we care about so we can ignore it.
2336         return;
2337     }
2339     $courseid = $event->courseid;
2340     $modulename = $event->modulename;
2341     $instanceid = $event->instance;
2342     $modified = false;
2343     $closedatechanged = false;
2345     // Something weird going on. The event is for a different module so
2346     // we should ignore it.
2347     if ($modulename != 'quiz') {
2348         return;
2349     }
2351     if ($quiz->id != $instanceid) {
2352         // The provided quiz instance doesn't match the event so
2353         // there is nothing to do here.
2354         return;
2355     }
2357     // We don't update the activity if it's an override event that has
2358     // been modified.
2359     if (quiz_is_overriden_calendar_event($event)) {
2360         return;
2361     }
2363     $coursemodule = get_fast_modinfo($courseid)->instances[$modulename][$instanceid];
2364     $context = context_module::instance($coursemodule->id);
2366     // The user does not have the capability to modify this activity.
2367     if (!has_capability('moodle/course:manageactivities', $context)) {
2368         return;
2369     }
2371     if ($event->eventtype == QUIZ_EVENT_TYPE_OPEN) {
2372         // If the event is for the quiz activity opening then we should
2373         // set the start time of the quiz activity to be the new start
2374         // time of the event.
2375         if ($quiz->timeopen != $event->timestart) {
2376             $quiz->timeopen = $event->timestart;
2377             $modified = true;
2378         }
2379     } else if ($event->eventtype == QUIZ_EVENT_TYPE_CLOSE) {
2380         // If the event is for the quiz activity closing then we should
2381         // set the end time of the quiz activity to be the new start
2382         // time of the event.
2383         if ($quiz->timeclose != $event->timestart) {
2384             $quiz->timeclose = $event->timestart;
2385             $modified = true;
2386             $closedatechanged = true;
2387         }
2388     }
2390     if ($modified) {
2391         $quiz->timemodified = time();
2392         $DB->update_record('quiz', $quiz);
2394         if ($closedatechanged) {
2395             quiz_update_open_attempts(array('quizid' => $quiz->id));
2396         }
2398         // Delete any previous preview attempts.
2399         quiz_delete_previews($quiz);
2400         quiz_update_events($quiz);
2401         $event = \core\event\course_module_updated::create_from_cm($coursemodule, $context);
2402         $event->trigger();
2403     }
2406 /**
2407  * Generates the question bank in a fragment output. This allows
2408  * the question bank to be displayed in a modal.
2409  *
2410  * The only expected argument provided in the $args array is
2411  * 'querystring'. The value should be the list of parameters
2412  * URL encoded and used to build the question bank page.
2413  *
2414  * The individual list of parameters expected can be found in
2415  * question_build_edit_resources.
2416  *
2417  * @param array $args The fragment arguments.
2418  * @return string The rendered mform fragment.
2419  */
2420 function mod_quiz_output_fragment_quiz_question_bank($args) {
2421     global $CFG, $DB, $PAGE;
2422     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
2423     require_once($CFG->dirroot . '/question/editlib.php');
2425     $querystring = preg_replace('/^\?/', '', $args['querystring']);
2426     $params = [];
2427     parse_str($querystring, $params);
2429     // Build the required resources. The $params are all cleaned as
2430     // part of this process.
2431     list($thispageurl, $contexts, $cmid, $cm, $quiz, $pagevars) =
2432             question_build_edit_resources('editq', '/mod/quiz/edit.php', $params);
2434     // Get the course object and related bits.
2435     $course = $DB->get_record('course', array('id' => $quiz->course), '*', MUST_EXIST);
2436     require_capability('mod/quiz:manage', $contexts->lowest());
2438     // Create quiz question bank view.
2439     $questionbank = new mod_quiz\question\bank\custom_view($contexts, $thispageurl, $course, $cm, $quiz);
2440     $questionbank->set_quiz_has_attempts(quiz_has_attempts($quiz->id));
2442     // Output.
2443     $renderer = $PAGE->get_renderer('mod_quiz', 'edit');
2444     return $renderer->question_bank_contents($questionbank, $pagevars);
2447 /**
2448  * Generates the add random question in a fragment output. This allows the
2449  * form to be rendered in javascript, for example inside a modal.
2450  *
2451  * The required arguments as keys in the $args array are:
2452  *      cat {string} The category and category context ids comma separated.
2453  *      addonpage {int} The page id to add this question to.
2454  *      returnurl {string} URL to return to after form submission.
2455  *      cmid {int} The course module id the questions are being added to.
2456  *
2457  * @param array $args The fragment arguments.
2458  * @return string The rendered mform fragment.
2459  */
2460 function mod_quiz_output_fragment_add_random_question_form($args) {
2461     global $CFG;
2462     require_once($CFG->dirroot . '/mod/quiz/addrandomform.php');
2464     $contexts = new \question_edit_contexts($args['context']);
2465     $formoptions = [
2466         'contexts' => $contexts,
2467         'cat' => $args['cat']
2468     ];
2469     $formdata = [
2470         'category' => $args['cat'],
2471         'addonpage' => $args['addonpage'],
2472         'returnurl' => $args['returnurl'],
2473         'cmid' => $args['cmid']
2474     ];
2476     $form = new quiz_add_random_form(
2477         new \moodle_url('/mod/quiz/addrandom.php'),
2478         $formoptions,
2479         'post',
2480         '',
2481         null,
2482         true,
2483         $formdata
2484     );
2485     $form->set_data($formdata);
2487     return $form->render();