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