Merge remote-tracking branch 'moodle/master' into MDL-20636_master_new_question_engine
[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
24  * @subpackage quiz
25  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
30 defined('MOODLE_INTERNAL') || die();
32 require_once($CFG->libdir . '/eventslib.php');
33 require_once($CFG->dirroot . '/calendar/lib.php');
36 /**#@+
37  * Option controlling what options are offered on the quiz settings form.
38  */
39 define('QUIZ_MAX_ATTEMPT_OPTION', 10);
40 define('QUIZ_MAX_QPP_OPTION', 50);
41 define('QUIZ_MAX_DECIMAL_OPTION', 5);
42 define('QUIZ_MAX_Q_DECIMAL_OPTION', 7);
43 /**#@-*/
45 /**
46  * If start and end date for the quiz are more than this many seconds apart
47  * they will be represented by two separate events in the calendar
48  */
49 define('QUIZ_MAX_EVENT_LENGTH', 5*24*60*60); // 5 days
51 /**
52  * Given an object containing all the necessary data,
53  * (defined by the form in mod_form.php) this function
54  * will create a new instance and return the id number
55  * of the new instance.
56  *
57  * @param object $quiz the data that came from the form.
58  * @return mixed the id of the new instance on success,
59  *          false or a string error message on failure.
60  */
61 function quiz_add_instance($quiz) {
62     global $DB;
63     $cmid = $quiz->coursemodule;
65     // Process the options from the form.
66     $quiz->created = time();
67     $quiz->questions = '';
68     $result = quiz_process_options($quiz);
69     if ($result && is_string($result)) {
70         return $result;
71     }
73     // Try to store it in the database.
74     $quiz->id = $DB->insert_record('quiz', $quiz);
76     // Do the processing required after an add or an update.
77     quiz_after_add_or_update($quiz);
79     return $quiz->id;
80 }
82 /**
83  * Given an object containing all the necessary data,
84  * (defined by the form in mod_form.php) this function
85  * will update an existing instance with new data.
86  *
87  * @param object $quiz the data that came from the form.
88  * @return mixed true on success, false or a string error message on failure.
89  */
90 function quiz_update_instance($quiz, $mform) {
91     global $CFG, $DB;
93     // Process the options from the form.
94     $result = quiz_process_options($quiz);
95     if ($result && is_string($result)) {
96         return $result;
97     }
99     $oldquiz = $DB->get_record('quiz', array('id' => $quiz->instance));
101     // Repaginate, if asked to.
102     if (!$quiz->shufflequestions && !empty($quiz->repaginatenow)) {
103         require_once($CFG->dirroot . '/mod/quiz/locallib.php');
104         $quiz->questions = quiz_repaginate($oldquiz->questions, $quiz->questionsperpage);
105     }
106     unset($quiz->repaginatenow);
108     // Update the database.
109     $quiz->id = $quiz->instance;
110     $DB->update_record('quiz', $quiz);
112     // Do the processing required after an add or an update.
113     quiz_after_add_or_update($quiz);
115     if ($oldquiz->grademethod != $quiz->grademethod) {
116         require_once($CFG->dirroot . '/mod/quiz/locallib.php');
117         $quiz->sumgrades = $oldquiz->sumgrades;
118         $quiz->grade = $oldquiz->grade;
119         quiz_update_all_final_grades($quiz);
120         quiz_update_grades($quiz);
121     }
123     // Delete any previous preview attempts
124     quiz_delete_previews($quiz);
126     return true;
129 /**
130  * Given an ID of an instance of this module,
131  * this function will permanently delete the instance
132  * and any data that depends on it.
133  *
134  * @param int $id the id of the quiz to delete.
135  * @return bool success or failure.
136  */
137 function quiz_delete_instance($id) {
138     global $DB;
140     $quiz = $DB->get_record('quiz', array('id' => $id), '*', MUST_EXIST);
142     quiz_delete_all_attempts($quiz);
143     quiz_delete_all_overrides($quiz);
145     $DB->delete_records('quiz_question_instances', array('quiz' => $quiz->id));
146     $DB->delete_records('quiz_feedback', array('quizid' => $quiz->id));
148     $events = $DB->get_records('event', array('modulename' => 'quiz', 'instance' => $quiz->id));
149     foreach ($events as $event) {
150         $event = calendar_event::load($event);
151         $event->delete();
152     }
154     quiz_grade_item_delete($quiz);
155     $DB->delete_records('quiz', array('id' => $quiz->id));
157     return true;
160 /**
161  * Deletes a quiz override from the database and clears any corresponding calendar events
162  *
163  * @param object $quiz The quiz object.
164  * @param int $overrideid The id of the override being deleted
165  * @return bool true on success
166  */
167 function quiz_delete_override($quiz, $overrideid) {
168     global $DB;
170     $override = $DB->get_record('quiz_overrides', array('id' => $overrideid), '*', MUST_EXIST);
172     // Delete the events
173     $events = $DB->get_records('event', array('modulename' => 'quiz',
174             'instance' => $quiz->id, 'groupid' => (int)$override->groupid,
175             'userid' => (int)$override->userid));
176     foreach ($events as $event) {
177         $eventold = calendar_event::load($event);
178         $eventold->delete();
179     }
181     $DB->delete_records('quiz_overrides', array('id' => $overrideid));
182     return true;
185 /**
186  * Deletes all quiz overrides from the database and clears any corresponding calendar events
187  *
188  * @param object $quiz The quiz object.
189  */
190 function quiz_delete_all_overrides($quiz) {
191     global $DB;
193     $overrides = $DB->get_records('quiz_overrides', array('quiz' => $quiz->id), 'id');
194     foreach ($overrides as $override) {
195         quiz_delete_override($quiz, $override->id);
196     }
199 /**
200  * Updates a quiz object with override information for a user.
201  *
202  * Algorithm:  For each quiz setting, if there is a matching user-specific override,
203  *   then use that otherwise, if there are group-specific overrides, return the most
204  *   lenient combination of them.  If neither applies, leave the quiz setting unchanged.
205  *
206  *   Special case: if there is more than one password that applies to the user, then
207  *   quiz->extrapasswords will contain an array of strings giving the remaining
208  *   passwords.
209  *
210  * @param object $quiz The quiz object.
211  * @param int $userid The userid.
212  * @return object $quiz The updated quiz object.
213  */
214 function quiz_update_effective_access($quiz, $userid) {
215     global $DB;
217     // check for user override
218     $override = $DB->get_record('quiz_overrides', array('quiz' => $quiz->id, 'userid' => $userid));
220     if (!$override) {
221         $override = new stdClass();
222         $override->timeopen = null;
223         $override->timeclose = null;
224         $override->timelimit = null;
225         $override->attempts = null;
226         $override->password = null;
227     }
229     // check for group overrides
230     $groupings = groups_get_user_groups($quiz->course, $userid);
232     if (!empty($groupings[0])) {
233         // Select all overrides that apply to the User's groups
234         list($extra, $params) = $DB->get_in_or_equal(array_values($groupings[0]));
235         $sql = "SELECT * FROM {quiz_overrides}
236                 WHERE groupid $extra AND quiz = ?";
237         $params[] = $quiz->id;
238         $records = $DB->get_records_sql($sql, $params);
240         // Combine the overrides
241         $opens = array();
242         $closes = array();
243         $limits = array();
244         $attempts = array();
245         $passwords = array();
247         foreach ($records as $gpoverride) {
248             if (isset($gpoverride->timeopen)) {
249                 $opens[] = $gpoverride->timeopen;
250             }
251             if (isset($gpoverride->timeclose)) {
252                 $closes[] = $gpoverride->timeclose;
253             }
254             if (isset($gpoverride->timelimit)) {
255                 $limits[] = $gpoverride->timelimit;
256             }
257             if (isset($gpoverride->attempts)) {
258                 $attempts[] = $gpoverride->attempts;
259             }
260             if (isset($gpoverride->password)) {
261                 $passwords[] = $gpoverride->password;
262             }
263         }
264         // If there is a user override for a setting, ignore the group override
265         if (is_null($override->timeopen) && count($opens)) {
266             $override->timeopen = min($opens);
267         }
268         if (is_null($override->timeclose) && count($closes)) {
269             $override->timeclose = max($closes);
270         }
271         if (is_null($override->timelimit) && count($limits)) {
272             $override->timelimit = max($limits);
273         }
274         if (is_null($override->attempts) && count($attempts)) {
275             $override->attempts = max($attempts);
276         }
277         if (is_null($override->password) && count($passwords)) {
278             $override->password = array_shift($passwords);
279             if (count($passwords)) {
280                 $override->extrapasswords = $passwords;
281             }
282         }
284     }
286     // merge with quiz defaults
287     $keys = array('timeopen', 'timeclose', 'timelimit', 'attempts', 'password', 'extrapasswords');
288     foreach ($keys as $key) {
289         if (isset($override->{$key})) {
290             $quiz->{$key} = $override->{$key};
291         }
292     }
294     return $quiz;
297 /**
298  * Delete all the attempts belonging to a quiz.
299  *
300  * @param object $quiz The quiz object.
301  */
302 function quiz_delete_all_attempts($quiz) {
303     global $CFG, $DB;
304     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
305     question_engine::delete_questions_usage_by_activities(new qubaids_for_quiz($quiz->id));
306     $DB->delete_records('quiz_attempts', array('quiz' => $quiz->id));
307     $DB->delete_records('quiz_grades', array('quiz' => $quiz->id));
310 /**
311  * Get the best current grade for a particular user in a quiz.
312  *
313  * @param object $quiz the quiz settings.
314  * @param int $userid the id of the user.
315  * @return float the user's current grade for this quiz, or null if this user does
316  * not have a grade on this quiz.
317  */
318 function quiz_get_best_grade($quiz, $userid) {
319     global $DB;
320     $grade = $DB->get_field('quiz_grades', 'grade',
321             array('quiz' => $quiz->id, 'userid' => $userid));
323     // Need to detect errors/no result, without catching 0 grades.
324     if ($grade === false) {
325         return null;
326     }
328     return $grade + 0; // Convert to number.
331 /**
332  * Is this a graded quiz? If this method returns true, you can assume that
333  * $quiz->grade and $quiz->sumgrades are non-zero (for example, if you want to
334  * divide by them).
335  *
336  * @param object $quiz a row from the quiz table.
337  * @return bool whether this is a graded quiz.
338  */
339 function quiz_has_grades($quiz) {
340     return $quiz->grade >= 0.000005 && $quiz->sumgrades >= 0.000005;
343 /**
344  * Return a small object with summary information about what a
345  * user has done with a given particular instance of this module
346  * Used for user activity reports.
347  * $return->time = the time they did it
348  * $return->info = a short text description
349  *
350  * @param object $course
351  * @param object $user
352  * @param object $mod
353  * @param object $quiz
354  * @return object|null
355  */
356 function quiz_user_outline($course, $user, $mod, $quiz) {
357     global $DB, $CFG;
358     require_once("$CFG->libdir/gradelib.php");
359     $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id);
361     if (empty($grades->items[0]->grades)) {
362         return null;
363     } else {
364         $grade = reset($grades->items[0]->grades);
365     }
367     $result = new stdClass();
368     $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
370     //datesubmitted == time created. dategraded == time modified or time overridden
371     //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
372     //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
373     if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
374         $result->time = $grade->dategraded;
375     } else {
376         $result->time = $grade->datesubmitted;
377     }
379     return $result;
382 /**
383  * Print a detailed representation of what a  user has done with
384  * a given particular instance of this module, for user activity reports.
385  *
386  * @global object
387  * @param object $course
388  * @param object $user
389  * @param object $mod
390  * @param object $quiz
391  * @return bool
392  */
393 function quiz_user_complete($course, $user, $mod, $quiz) {
394     global $DB, $CFG, $OUTPUT;
395     require_once("$CFG->libdir/gradelib.php");
397     $grades = grade_get_grades($course->id, 'mod', 'quiz', $quiz->id, $user->id);
398     if (!empty($grades->items[0]->grades)) {
399         $grade = reset($grades->items[0]->grades);
400         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
401         if ($grade->str_feedback) {
402             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
403         }
404     }
406     if ($attempts = $DB->get_records('quiz_attempts',
407             array('userid' => $user->id, 'quiz' => $quiz->id), 'attempt')) {
408         foreach ($attempts as $attempt) {
409             echo get_string('attempt', 'quiz').' '.$attempt->attempt.': ';
410             if ($attempt->timefinish == 0) {
411                 print_string('unfinished');
412             } else {
413                 echo quiz_format_grade($quiz, $attempt->sumgrades) . '/' .
414                         quiz_format_grade($quiz, $quiz->sumgrades);
415             }
416             echo ' - '.userdate($attempt->timemodified).'<br />';
417         }
418     } else {
419         print_string('noattempts', 'quiz');
420     }
422     return true;
425 /**
426  * Function to be run periodically according to the moodle cron
427  * This function searches for things that need to be done, such
428  * as sending out mail, toggling flags etc ...
429  *
430  * @return bool true
431  */
432 function quiz_cron() {
433     return true;
436 /**
437  * @param int $quizid the quiz id.
438  * @param int $userid the userid.
439  * @param string $status 'all', 'finished' or 'unfinished' to control
440  * @param bool $includepreviews
441  * @return an array of all the user's attempts at this quiz. Returns an empty
442  *      array if there are none.
443  */
444 function quiz_get_user_attempts($quizid, $userid, $status = 'finished', $includepreviews = false) {
445     global $DB;
446     $status_condition = array(
447         'all' => '',
448         'finished' => ' AND timefinish > 0',
449         'unfinished' => ' AND timefinish = 0'
450     );
451     $previewclause = '';
452     if (!$includepreviews) {
453         $previewclause = ' AND preview = 0';
454     }
455     return $DB->get_records_select('quiz_attempts',
456             'quiz = ? AND userid = ?' . $previewclause . $status_condition[$status],
457             array($quizid, $userid), 'attempt ASC');
460 /**
461  * Return grade for given user or all users.
462  *
463  * @param int $quizid id of quiz
464  * @param int $userid optional user id, 0 means all users
465  * @return array array of grades, false if none. These are raw grades. They should
466  * be processed with quiz_format_grade for display.
467  */
468 function quiz_get_user_grades($quiz, $userid = 0) {
469     global $CFG, $DB;
471     $params = array($quiz->id);
472     $usertest = '';
473     if ($userid) {
474         $params[] = $userid;
475         $usertest = 'AND u.id = ?';
476     }
477     return $DB->get_records_sql("
478             SELECT
479                 u.id,
480                 u.id AS userid,
481                 qg.grade AS rawgrade,
482                 qg.timemodified AS dategraded,
483                 MAX(qa.timefinish) AS datesubmitted
485             FROM {user} u
486             JOIN {quiz_grades} qg ON u.id = qg.userid
487             JOIN {quiz_attempts} qa ON qa.quiz = qg.quiz AND qa.userid = u.id
489             WHERE qg.quiz = ?
490             $usertest
491             GROUP BY u.id, qg.grade, qg.timemodified", $params);
494 /**
495  * Round a grade to to the correct number of decimal places, and format it for display.
496  *
497  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
498  * @param float $grade The grade to round.
499  * @return float
500  */
501 function quiz_format_grade($quiz, $grade) {
502     if (is_null($grade)) {
503         return get_string('notyetgraded', 'quiz');
504     }
505     return format_float($grade, $quiz->decimalpoints);
508 /**
509  * Round a grade to to the correct number of decimal places, and format it for display.
510  *
511  * @param object $quiz The quiz table row, only $quiz->decimalpoints is used.
512  * @param float $grade The grade to round.
513  * @return float
514  */
515 function quiz_format_question_grade($quiz, $grade) {
516     if (empty($quiz->questiondecimalpoints)) {
517         $quiz->questiondecimalpoints = -1;
518     }
519     if ($quiz->questiondecimalpoints == -1) {
520         return format_float($grade, $quiz->decimalpoints);
521     } else {
522         return format_float($grade, $quiz->questiondecimalpoints);
523     }
526 /**
527  * Update grades in central gradebook
528  *
529  * @param object $quiz the quiz settings.
530  * @param int $userid specific user only, 0 means all users.
531  */
532 function quiz_update_grades($quiz, $userid = 0, $nullifnone = true) {
533     global $CFG, $DB;
534     require_once($CFG->libdir.'/gradelib.php');
536     if ($quiz->grade == 0) {
537         quiz_grade_item_update($quiz);
539     } else if ($grades = quiz_get_user_grades($quiz, $userid)) {
540         quiz_grade_item_update($quiz, $grades);
542     } else if ($userid && $nullifnone) {
543         $grade = new stdClass();
544         $grade->userid = $userid;
545         $grade->rawgrade = null;
546         quiz_grade_item_update($quiz, $grade);
548     } else {
549         quiz_grade_item_update($quiz);
550     }
553 /**
554  * Update all grades in gradebook.
555  */
556 function quiz_upgrade_grades() {
557     global $DB;
559     $sql = "SELECT COUNT('x')
560               FROM {quiz} a, {course_modules} cm, {modules} m
561              WHERE m.name='quiz' AND m.id=cm.module AND cm.instance=a.id";
562     $count = $DB->count_records_sql($sql);
564     $sql = "SELECT a.*, cm.idnumber AS cmidnumber, a.course AS courseid
565               FROM {quiz} a, {course_modules} cm, {modules} m
566              WHERE m.name='quiz' AND m.id=cm.module AND cm.instance=a.id";
567     $rs = $DB->get_recordset_sql($sql);
568     if ($rs->valid()) {
569         $pbar = new progress_bar('quizupgradegrades', 500, true);
570         $i=0;
571         foreach ($rs as $quiz) {
572             $i++;
573             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
574             quiz_update_grades($quiz, 0, false);
575             $pbar->update($i, $count, "Updating Quiz grades ($i/$count).");
576         }
577     }
578     $rs->close();
581 /**
582  * Create grade item for given quiz
583  *
584  * @param object $quiz object with extra cmidnumber
585  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
586  * @return int 0 if ok, error code otherwise
587  */
588 function quiz_grade_item_update($quiz, $grades = null) {
589     global $CFG, $OUTPUT;
590     require_once($CFG->libdir.'/gradelib.php');
592     if (array_key_exists('cmidnumber', $quiz)) { // may not be always present
593         $params = array('itemname' => $quiz->name, 'idnumber' => $quiz->cmidnumber);
594     } else {
595         $params = array('itemname' => $quiz->name);
596     }
598     if ($quiz->grade > 0) {
599         $params['gradetype'] = GRADE_TYPE_VALUE;
600         $params['grademax']  = $quiz->grade;
601         $params['grademin']  = 0;
603     } else {
604         $params['gradetype'] = GRADE_TYPE_NONE;
605     }
607     // description by TJ:
608     // 1. If the quiz is set to not show grades while the quiz is still open,
609     //    and is set to show grades after the quiz is closed, then create the
610     //    grade_item with a show-after date that is the quiz close date.
611     // 2. If the quiz is set to not show grades at either of those times,
612     //    create the grade_item as hidden.
613     // 3. If the quiz is set to show grades, create the grade_item visible.
614     $openreviewoptions = mod_quiz_display_options::make_from_quiz($quiz,
615             mod_quiz_display_options::LATER_WHILE_OPEN);
616     $closedreviewoptions = mod_quiz_display_options::make_from_quiz($quiz,
617             mod_quiz_display_options::AFTER_CLOSE);
618     if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX &&
619             $closedreviewoptions->marks < question_display_options::MARK_AND_MAX) {
620         $params['hidden'] = 1;
622     } else if ($openreviewoptions->marks < question_display_options::MARK_AND_MAX &&
623             $closedreviewoptions->marks >= question_display_options::MARK_AND_MAX) {
624         if ($quiz->timeclose) {
625             $params['hidden'] = $quiz->timeclose;
626         } else {
627             $params['hidden'] = 1;
628         }
630     } else {
631         // a) both open and closed enabled
632         // b) open enabled, closed disabled - we can not "hide after",
633         //    grades are kept visible even after closing
634         $params['hidden'] = 0;
635     }
637     if ($grades  === 'reset') {
638         $params['reset'] = true;
639         $grades = null;
640     }
642     $gradebook_grades = grade_get_grades($quiz->course, 'mod', 'quiz', $quiz->id);
643     if (!empty($gradebook_grades->items)) {
644         $grade_item = $gradebook_grades->items[0];
645         if ($grade_item->locked) {
646             $confirm_regrade = optional_param('confirm_regrade', 0, PARAM_INT);
647             if (!$confirm_regrade) {
648                 $message = get_string('gradeitemislocked', 'grades');
649                 $back_link = $CFG->wwwroot . '/mod/quiz/report.php?q=' . $quiz->id .
650                         '&amp;mode=overview';
651                 $regrade_link = qualified_me() . '&amp;confirm_regrade=1';
652                 echo $OUTPUT->box_start('generalbox', 'notice');
653                 echo '<p>'. $message .'</p>';
654                 echo $OUTPUT->container_start('buttons');
655                 echo $OUTPUT->single_button($regrade_link, get_string('regradeanyway', 'grades'));
656                 echo $OUTPUT->single_button($back_link,  get_string('cancel'));
657                 echo $OUTPUT->container_end();
658                 echo $OUTPUT->box_end();
660                 return GRADE_UPDATE_ITEM_LOCKED;
661             }
662         }
663     }
665     return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0, $grades, $params);
668 /**
669  * Delete grade item for given quiz
670  *
671  * @param object $quiz object
672  * @return object quiz
673  */
674 function quiz_grade_item_delete($quiz) {
675     global $CFG;
676     require_once($CFG->libdir . '/gradelib.php');
678     return grade_update('mod/quiz', $quiz->course, 'mod', 'quiz', $quiz->id, 0,
679             null, array('deleted' => 1));
682 /**
683  * Returns an array of users who have data in a given quiz
684  *
685  * @todo: deprecated - to be deleted in 2.2
686  *
687  * @param int $quizid the quiz id.
688  * @return array of userids.
689  */
690 function quiz_get_participants($quizid) {
691     global $CFG, $DB;
693     return $DB->get_records_sql('
694             SELECT DISTINCT userid, userid
695             JOIN {quiz_attempts} qa
696             WHERE a.quiz = ?', array($quizid));
699 /**
700  * This standard function will check all instances of this module
701  * and make sure there are up-to-date events created for each of them.
702  * If courseid = 0, then every quiz event in the site is checked, else
703  * only quiz events belonging to the course specified are checked.
704  * This function is used, in its new format, by restore_refresh_events()
705  *
706  * @param int $courseid
707  * @return bool
708  */
709 function quiz_refresh_events($courseid = 0) {
710     global $DB;
712     if ($courseid == 0) {
713         if (!$quizzes = $DB->get_records('quiz')) {
714             return true;
715         }
716     } else {
717         if (!$quizzes = $DB->get_records('quiz', array('course' => $courseid))) {
718             return true;
719         }
720     }
722     foreach ($quizzes as $quiz) {
723         quiz_update_events($quiz);
724     }
726     return true;
729 /**
730  * Returns all quiz graded users since a given time for specified quiz
731  */
732 function quiz_get_recent_mod_activity(&$activities, &$index, $timestart,
733         $courseid, $cmid, $userid = 0, $groupid = 0) {
734     global $CFG, $COURSE, $USER, $DB;
735     require_once('locallib.php');
737     if ($COURSE->id == $courseid) {
738         $course = $COURSE;
739     } else {
740         $course = $DB->get_record('course', array('id' => $courseid));
741     }
743     $modinfo =& get_fast_modinfo($course);
745     $cm = $modinfo->cms[$cmid];
746     $quiz = $DB->get_record('quiz', array('id' => $cm->instance));
748     if ($userid) {
749         $userselect = "AND u.id = :userid";
750         $params['userid'] = $userid;
751     } else {
752         $userselect = '';
753     }
755     if ($groupid) {
756         $groupselect = 'AND gm.groupid = :groupid';
757         $groupjoin   = 'JOIN {groups_members} gm ON  gm.userid=u.id';
758         $params['groupid'] = $groupid;
759     } else {
760         $groupselect = '';
761         $groupjoin   = '';
762     }
764     $params['timestart'] = $timestart;
765     $params['quizid'] = $quiz->id;
767     if (!$attempts = $DB->get_records_sql("
768               SELECT qa.*,
769                      u.firstname, u.lastname, u.email, u.picture, u.imagealt
770                 FROM {quiz_attempts} qa
771                      JOIN {user} u ON u.id = qa.userid
772                      $groupjoin
773                WHERE qa.timefinish > :timestart
774                  AND qa.quiz = :quizid
775                  AND qa.preview = 0
776                      $userselect
777                      $groupselect
778             ORDER BY qa.timefinish ASC", $params)) {
779         return;
780     }
782     $context         = get_context_instance(CONTEXT_MODULE, $cm->id);
783     $accessallgroups = has_capability('moodle/site:accessallgroups', $context);
784     $viewfullnames   = has_capability('moodle/site:viewfullnames', $context);
785     $grader          = has_capability('mod/quiz:viewreports', $context);
786     $groupmode       = groups_get_activity_groupmode($cm, $course);
788     if (is_null($modinfo->groups)) {
789         // load all my groups and cache it in modinfo
790         $modinfo->groups = groups_get_user_groups($course->id);
791     }
793     $usersgroups = null;
794     $aname = format_string($cm->name, true);
795     foreach ($attempts as $attempt) {
796         if ($attempt->userid != $USER->id) {
797             if (!$grader) {
798                 // Grade permission required
799                 continue;
800             }
802             if ($groupmode == SEPARATEGROUPS and !$accessallgroups) {
803                 if (is_null($usersgroups)) {
804                     $usersgroups = groups_get_all_groups($course->id,
805                             $attempt->userid, $cm->groupingid);
806                     if (is_array($usersgroups)) {
807                         $usersgroups = array_keys($usersgroups);
808                     } else {
809                         $usersgroups = array();
810                     }
811                 }
812                 if (!array_intersect($usersgroups, $modinfo->groups[$cm->id])) {
813                     continue;
814                 }
815             }
816         }
818         $options = quiz_get_review_options($quiz, $attempt, $context);
820         $tmpactivity = new stdClass();
822         $tmpactivity->type       = 'quiz';
823         $tmpactivity->cmid       = $cm->id;
824         $tmpactivity->name       = $aname;
825         $tmpactivity->sectionnum = $cm->sectionnum;
826         $tmpactivity->timestamp  = $attempt->timefinish;
828         $tmpactivity->content->attemptid = $attempt->id;
829         $tmpactivity->content->attempt   = $attempt->attempt;
830         if (quiz_has_grades($quiz) && $options->marks >= question_display_options::MARK_AND_MAX) {
831             $tmpactivity->content->sumgrades = quiz_format_grade($quiz, $attempt->sumgrades);
832             $tmpactivity->content->maxgrade  = quiz_format_grade($quiz, $quiz->sumgrades);
833         } else {
834             $tmpactivity->content->sumgrades = null;
835             $tmpactivity->content->maxgrade  = null;
836         }
838         $tmpactivity->user->id        = $attempt->userid;
839         $tmpactivity->user->firstname = $attempt->firstname;
840         $tmpactivity->user->lastname  = $attempt->lastname;
841         $tmpactivity->user->fullname  = fullname($attempt, $viewfullnames);
842         $tmpactivity->user->picture   = $attempt->picture;
843         $tmpactivity->user->imagealt  = $attempt->imagealt;
844         $tmpactivity->user->email     = $attempt->email;
846         $activities[$index++] = $tmpactivity;
847     }
850 function quiz_print_recent_mod_activity($activity, $courseid, $detail, $modnames) {
851     global $CFG, $OUTPUT;
853     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
855     echo '<tr><td class="userpicture" valign="top">';
856     echo $OUTPUT->user_picture($activity->user, array('courseid' => $courseid));
857     echo '</td><td>';
859     if ($detail) {
860         $modname = $modnames[$activity->type];
861         echo '<div class="title">';
862         echo '<img src="' . $OUTPUT->pix_url('icon', $activity->type) . '" ' .
863                 'class="icon" alt="' . $modname . '" />';
864         echo '<a href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' .
865                 $activity->cmid . '">' . $activity->name . '</a>';
866         echo '</div>';
867     }
869     echo '<div class="grade">';
870     echo  get_string('attempt', 'quiz', $activity->content->attempt);
871     if (isset($activity->content->maxgrade)) {
872         $grades = $activity->content->sumgrades . ' / ' . $activity->content->maxgrade;
873         echo ': (<a href="' . $CFG->wwwroot . '/mod/quiz/review.php?attempt=' .
874                 $activity->content->attemptid . '">' . $grades . '</a>)';
875     }
876     echo '</div>';
878     echo '<div class="user">';
879     echo '<a href="' . $CFG->wwwroot . '/user/view.php?id=' . $activity->user->id .
880             '&amp;course=' . $courseid . '">' . $activity->user->fullname .
881             '</a> - ' . userdate($activity->timestamp);
882     echo '</div>';
884     echo '</td></tr></table>';
886     return;
889 /**
890  * Pre-process the quiz options form data, making any necessary adjustments.
891  * Called by add/update instance in this file.
892  *
893  * @param object $quiz The variables set on the form.
894  */
895 function quiz_process_options($quiz) {
896     global $CFG;
897     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
898     require_once($CFG->libdir . '/questionlib.php');
900     $quiz->timemodified = time();
902     // Quiz name.
903     if (!empty($quiz->name)) {
904         $quiz->name = trim($quiz->name);
905     }
907     // Password field - different in form to stop browsers that remember passwords
908     // getting confused.
909     $quiz->password = $quiz->quizpassword;
910     unset($quiz->quizpassword);
912     // Quiz feedback
913     if (isset($quiz->feedbacktext)) {
914         // Clean up the boundary text.
915         for ($i = 0; $i < count($quiz->feedbacktext); $i += 1) {
916             if (empty($quiz->feedbacktext[$i]['text'])) {
917                 $quiz->feedbacktext[$i]['text'] = '';
918             } else {
919                 $quiz->feedbacktext[$i]['text'] = trim($quiz->feedbacktext[$i]['text']);
920             }
921         }
923         // Check the boundary value is a number or a percentage, and in range.
924         $i = 0;
925         while (!empty($quiz->feedbackboundaries[$i])) {
926             $boundary = trim($quiz->feedbackboundaries[$i]);
927             if (!is_numeric($boundary)) {
928                 if (strlen($boundary) > 0 && $boundary[strlen($boundary) - 1] == '%') {
929                     $boundary = trim(substr($boundary, 0, -1));
930                     if (is_numeric($boundary)) {
931                         $boundary = $boundary * $quiz->grade / 100.0;
932                     } else {
933                         return get_string('feedbackerrorboundaryformat', 'quiz', $i + 1);
934                     }
935                 }
936             }
937             if ($boundary <= 0 || $boundary >= $quiz->grade) {
938                 return get_string('feedbackerrorboundaryoutofrange', 'quiz', $i + 1);
939             }
940             if ($i > 0 && $boundary >= $quiz->feedbackboundaries[$i - 1]) {
941                 return get_string('feedbackerrororder', 'quiz', $i + 1);
942             }
943             $quiz->feedbackboundaries[$i] = $boundary;
944             $i += 1;
945         }
946         $numboundaries = $i;
948         // Check there is nothing in the remaining unused fields.
949         if (!empty($quiz->feedbackboundaries)) {
950             for ($i = $numboundaries; $i < count($quiz->feedbackboundaries); $i += 1) {
951                 if (!empty($quiz->feedbackboundaries[$i]) &&
952                         trim($quiz->feedbackboundaries[$i]) != '') {
953                     return get_string('feedbackerrorjunkinboundary', 'quiz', $i + 1);
954                 }
955             }
956         }
957         for ($i = $numboundaries + 1; $i < count($quiz->feedbacktext); $i += 1) {
958             if (!empty($quiz->feedbacktext[$i]['text']) &&
959                     trim($quiz->feedbacktext[$i]['text']) != '') {
960                 return get_string('feedbackerrorjunkinfeedback', 'quiz', $i + 1);
961             }
962         }
963         // Needs to be bigger than $quiz->grade because of '<' test in quiz_feedback_for_grade().
964         $quiz->feedbackboundaries[-1] = $quiz->grade + 1;
965         $quiz->feedbackboundaries[$numboundaries] = 0;
966         $quiz->feedbackboundarycount = $numboundaries;
967     }
969     // Combing the individual settings into the review columns.
970     $quiz->reviewattempt = quiz_review_option_form_to_db($quiz, 'attempt');
971     $quiz->reviewcorrectness = quiz_review_option_form_to_db($quiz, 'correctness');
972     $quiz->reviewmarks = quiz_review_option_form_to_db($quiz, 'marks');
973     $quiz->reviewspecificfeedback = quiz_review_option_form_to_db($quiz, 'specificfeedback');
974     $quiz->reviewgeneralfeedback = quiz_review_option_form_to_db($quiz, 'generalfeedback');
975     $quiz->reviewrightanswer = quiz_review_option_form_to_db($quiz, 'rightanswer');
976     $quiz->reviewoverallfeedback = quiz_review_option_form_to_db($quiz, 'overallfeedback');
977     $quiz->reviewattempt |= mod_quiz_display_options::DURING;
978     $quiz->reviewoverallfeedback &= ~mod_quiz_display_options::DURING;
981 /**
982  * Helper function for {@link quiz_process_options()}.
983  * @param object $fromform the sumbitted form date.
984  * @param string $field one of the review option field names.
985  */
986 function quiz_review_option_form_to_db($fromform, $field) {
987     static $times = array(
988         'during' => mod_quiz_display_options::DURING,
989         'immediately' => mod_quiz_display_options::IMMEDIATELY_AFTER,
990         'open' => mod_quiz_display_options::LATER_WHILE_OPEN,
991         'closed' => mod_quiz_display_options::AFTER_CLOSE,
992     );
994     $review = 0;
995     foreach ($times as $whenname => $when) {
996         $fieldname = $field . $whenname;
997         if (isset($fromform->$fieldname)) {
998             $review |= $when;
999             unset($fromform->$fieldname);
1000         }
1001     }
1003     return $review;
1006 /**
1007  * This function is called at the end of quiz_add_instance
1008  * and quiz_update_instance, to do the common processing.
1009  *
1010  * @param object $quiz the quiz object.
1011  */
1012 function quiz_after_add_or_update($quiz) {
1013     global $DB;
1014     $cmid = $quiz->coursemodule;
1016     // we need to use context now, so we need to make sure all needed info is already in db
1017     $DB->set_field('course_modules', 'instance', $quiz->id, array('id'=>$cmid));
1018     $context = get_context_instance(CONTEXT_MODULE, $cmid);
1020     // Save the feedback
1021     $DB->delete_records('quiz_feedback', array('quizid' => $quiz->id));
1023     for ($i = 0; $i <= $quiz->feedbackboundarycount; $i++) {
1024         $feedback = new stdClass();
1025         $feedback->quizid = $quiz->id;
1026         $feedback->feedbacktext = $quiz->feedbacktext[$i]['text'];
1027         $feedback->feedbacktextformat = $quiz->feedbacktext[$i]['format'];
1028         $feedback->mingrade = $quiz->feedbackboundaries[$i];
1029         $feedback->maxgrade = $quiz->feedbackboundaries[$i - 1];
1030         $feedback->id = $DB->insert_record('quiz_feedback', $feedback);
1031         $feedbacktext = file_save_draft_area_files((int)$quiz->feedbacktext[$i]['itemid'],
1032                 $context->id, 'mod_quiz', 'feedback', $feedback->id,
1033                 array('subdirs' => false, 'maxfiles' => -1, 'maxbytes' => 0),
1034                 $quiz->feedbacktext[$i]['text']);
1035         $DB->set_field('quiz_feedback', 'feedbacktext', $feedbacktext,
1036                 array('id' => $feedback->id));
1037     }
1039     // Update the events relating to this quiz.
1040     quiz_update_events($quiz);
1042     //update related grade item
1043     quiz_grade_item_update($quiz);
1046 /**
1047  * This function updates the events associated to the quiz.
1048  * If $override is non-zero, then it updates only the events
1049  * associated with the specified override.
1050  *
1051  * @uses QUIZ_MAX_EVENT_LENGTH
1052  * @param object $quiz the quiz object.
1053  * @param object optional $override limit to a specific override
1054  */
1055 function quiz_update_events($quiz, $override = null) {
1056     global $DB;
1058     // Load the old events relating to this quiz.
1059     $conds = array('modulename'=>'quiz',
1060                    'instance'=>$quiz->id);
1061     if (!empty($override)) {
1062         // only load events for this override
1063         $conds['groupid'] = isset($override->groupid)?  $override->groupid : 0;
1064         $conds['userid'] = isset($override->userid)?  $override->userid : 0;
1065     }
1066     $oldevents = $DB->get_records('event', $conds);
1068     // Now make a todo list of all that needs to be updated
1069     if (empty($override)) {
1070         // We are updating the primary settings for the quiz, so we
1071         // need to add all the overrides
1072         $overrides = $DB->get_records('quiz_overrides', array('quiz' => $quiz->id));
1073         // as well as the original quiz (empty override)
1074         $overrides[] = new stdClass();
1075     } else {
1076         // Just do the one override
1077         $overrides = array($override);
1078     }
1080     foreach ($overrides as $current) {
1081         $groupid   = isset($current->groupid)?  $current->groupid : 0;
1082         $userid    = isset($current->userid)? $current->userid : 0;
1083         $timeopen  = isset($current->timeopen)?  $current->timeopen : $quiz->timeopen;
1084         $timeclose = isset($current->timeclose)? $current->timeclose : $quiz->timeclose;
1086         // only add open/close events for an override if they differ from the quiz default
1087         $addopen  = empty($current->id) || !empty($current->timeopen);
1088         $addclose = empty($current->id) || !empty($current->timeclose);
1090         $event = new stdClass();
1091         $event->description = $quiz->intro;
1092         // Events module won't show user events when the courseid is nonzero
1093         $event->courseid    = ($userid) ? 0 : $quiz->course;
1094         $event->groupid     = $groupid;
1095         $event->userid      = $userid;
1096         $event->modulename  = 'quiz';
1097         $event->instance    = $quiz->id;
1098         $event->timestart   = $timeopen;
1099         $event->timeduration = max($timeclose - $timeopen, 0);
1100         $event->visible     = instance_is_visible('quiz', $quiz);
1101         $event->eventtype   = 'open';
1103         // Determine the event name
1104         if ($groupid) {
1105             $params = new stdClass();
1106             $params->quiz = $quiz->name;
1107             $params->group = groups_get_group_name($groupid);
1108             if ($params->group === false) {
1109                 // group doesn't exist, just skip it
1110                 continue;
1111             }
1112             $eventname = get_string('overridegroupeventname', 'quiz', $params);
1113         } else if ($userid) {
1114             $params = new stdClass();
1115             $params->quiz = $quiz->name;
1116             $eventname = get_string('overrideusereventname', 'quiz', $params);
1117         } else {
1118             $eventname = $quiz->name;
1119         }
1120         if ($addopen or $addclose) {
1121             if ($timeclose and $timeopen and $event->timeduration <= QUIZ_MAX_EVENT_LENGTH) {
1122                 // Single event for the whole quiz.
1123                 if ($oldevent = array_shift($oldevents)) {
1124                     $event->id = $oldevent->id;
1125                 } else {
1126                     unset($event->id);
1127                 }
1128                 $event->name = $eventname;
1129                 // calendar_event::create will reuse a db record if the id field is set
1130                 calendar_event::create($event);
1131             } else {
1132                 // Separate start and end events.
1133                 $event->timeduration  = 0;
1134                 if ($timeopen && $addopen) {
1135                     if ($oldevent = array_shift($oldevents)) {
1136                         $event->id = $oldevent->id;
1137                     } else {
1138                         unset($event->id);
1139                     }
1140                     $event->name = $eventname.' ('.get_string('quizopens', 'quiz').')';
1141                     // calendar_event::create will reuse a db record if the id field is set
1142                     calendar_event::create($event);
1143                 }
1144                 if ($timeclose && $addclose) {
1145                     if ($oldevent = array_shift($oldevents)) {
1146                         $event->id = $oldevent->id;
1147                     } else {
1148                         unset($event->id);
1149                     }
1150                     $event->name      = $eventname.' ('.get_string('quizcloses', 'quiz').')';
1151                     $event->timestart = $timeclose;
1152                     $event->eventtype = 'close';
1153                     calendar_event::create($event);
1154                 }
1155             }
1156         }
1157     }
1159     // Delete any leftover events
1160     foreach ($oldevents as $badevent) {
1161         $badevent = calendar_event::load($badevent);
1162         $badevent->delete();
1163     }
1166 /**
1167  * @return array
1168  */
1169 function quiz_get_view_actions() {
1170     return array('view', 'view all', 'report', 'review');
1173 /**
1174  * @return array
1175  */
1176 function quiz_get_post_actions() {
1177     return array('attempt', 'close attempt', 'preview', 'editquestions',
1178             'delete attempt', 'manualgrade');
1181 /**
1182  * @param array $questionids of question ids.
1183  * @return bool whether any of these questions are used by any instance of this module.
1184  */
1185 function quiz_questions_in_use($questionids) {
1186     global $DB, $CFG;
1187     require_once($CFG->libdir . '/questionlib.php');
1188     list($test, $params) = $DB->get_in_or_equal($questionids);
1189     return $DB->record_exists_select('quiz_question_instances',
1190             'question ' . $test, $params) || question_engine::questions_in_use(
1191             $questionids, new qubaid_join('{quiz_attempts} quiza',
1192             'quiza.uniqueid', 'quiza.preview = 0'));
1195 /**
1196  * Implementation of the function for printing the form elements that control
1197  * whether the course reset functionality affects the quiz.
1198  *
1199  * @param $mform the course reset form that is being built.
1200  */
1201 function quiz_reset_course_form_definition($mform) {
1202     $mform->addElement('header', 'quizheader', get_string('modulenameplural', 'quiz'));
1203     $mform->addElement('advcheckbox', 'reset_quiz_attempts',
1204             get_string('removeallquizattempts', 'quiz'));
1207 /**
1208  * Course reset form defaults.
1209  * @return array the defaults.
1210  */
1211 function quiz_reset_course_form_defaults($course) {
1212     return array('reset_quiz_attempts' => 1);
1215 /**
1216  * Removes all grades from gradebook
1217  *
1218  * @param int $courseid
1219  * @param string optional type
1220  */
1221 function quiz_reset_gradebook($courseid, $type='') {
1222     global $CFG, $DB;
1224     $quizzes = $DB->get_records_sql("
1225             SELECT q.*, cm.idnumber as cmidnumber, q.course as courseid
1226             FROM {modules} m
1227             JOIN {course_modules} cm ON m.id = cm.module
1228             JOIN {quiz} q ON cm.instance = q.id
1229             WHERE m.name = 'quiz' AND cm.course = ?", array($courseid));
1231     foreach ($quizzes as $quiz) {
1232         quiz_grade_item_update($quiz, 'reset');
1233     }
1236 /**
1237  * Actual implementation of the reset course functionality, delete all the
1238  * quiz attempts for course $data->courseid, if $data->reset_quiz_attempts is
1239  * set and true.
1240  *
1241  * Also, move the quiz open and close dates, if the course start date is changing.
1242  *
1243  * @param object $data the data submitted from the reset course.
1244  * @return array status array
1245  */
1246 function quiz_reset_userdata($data) {
1247     global $CFG, $DB;
1248     require_once($CFG->libdir.'/questionlib.php');
1250     $componentstr = get_string('modulenameplural', 'quiz');
1251     $status = array();
1253     // Delete attempts.
1254     if (!empty($data->reset_quiz_attempts)) {
1255         require_once($CFG->libdir . '/questionlib.php');
1257         question_engine::delete_questions_usage_by_activities(new qubaid_join(
1258                 '{quiz_attempts} quiza JOIN {quiz} quiz ON quiza.quiz = quiz.id',
1259                 'quiza.uniqueid', 'quiz.course = :quizcourseid',
1260                 array('quizcourseid' => $data->courseid)));
1262         $DB->delete_records_select('quiz_attempts',
1263                 'quiz IN (SELECT id FROM {quiz} WHERE course = ?)', array($data->courseid));
1264         $status[] = array(
1265             'component' => $componentstr,
1266             'item' => get_string('attemptsdeleted', 'quiz'),
1267             'error' => false);
1269         // Remove all grades from gradebook
1270         if (empty($data->reset_gradebook_grades)) {
1271             quiz_reset_gradebook($data->courseid);
1272         }
1273         $status[] = array(
1274             'component' => $componentstr,
1275             'item' => get_string('attemptsdeleted', 'quiz'),
1276             'error' => false);
1277     }
1279     // Updating dates - shift may be negative too
1280     if ($data->timeshift) {
1281         shift_course_mod_dates('quiz', array('timeopen', 'timeclose'),
1282                 $data->timeshift, $data->courseid);
1283         $status[] = array(
1284             'component' => $componentstr,
1285             'item' => get_string('openclosedatesupdated', 'quiz'),
1286             'error' => false);
1287     }
1289     return $status;
1292 /**
1293  * Checks whether the current user is allowed to view a file uploaded in a quiz.
1294  * Teachers can view any from their courses, students can only view their own.
1295  *
1296  * @param int $attemptuniqueid int attempt id
1297  * @param int $questionid int question id
1298  * @return bool to indicate access granted or denied
1299  */
1300 function quiz_check_file_access($attemptuniqueid, $questionid, $context = null) {
1301     global $USER, $DB, $CFG;
1302     require_once(dirname(__FILE__).'/attemptlib.php');
1303     require_once(dirname(__FILE__).'/locallib.php');
1305     $attempt = $DB->get_record('quiz_attempts', array('uniqueid' => $attemptuniqueid));
1306     $attemptobj = quiz_attempt::create($attempt->id);
1308     // does question exist?
1309     if (!$question = $DB->get_record('question', array('id' => $questionid))) {
1310         return false;
1311     }
1313     if ($context === null) {
1314         $quiz = $DB->get_record('quiz', array('id' => $attempt->quiz));
1315         $cm = get_coursemodule_from_id('quiz', $quiz->id);
1316         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1317     }
1319     // Load those questions and the associated states.
1320     $attemptobj->load_questions(array($questionid));
1321     $attemptobj->load_question_states(array($questionid));
1323     // obtain state
1324     $state = $attemptobj->get_question_state($questionid);
1325     // obtain questoin
1326     $question = $attemptobj->get_question($questionid);
1328     // access granted if the current user submitted this file
1329     if ($attempt->userid != $USER->id) {
1330         return false;
1331     }
1332     // access granted if the current user has permission to grade quizzes in this course
1333     if (!(has_capability('mod/quiz:viewreports', $context) ||
1334             has_capability('mod/quiz:grade', $context))) {
1335         return false;
1336     }
1338     return array($question, $state, array());
1341 /**
1342  * Prints quiz summaries on MyMoodle Page
1343  * @param arry $courses
1344  * @param array $htmlarray
1345  */
1346 function quiz_print_overview($courses, &$htmlarray) {
1347     global $USER, $CFG;
1348     // These next 6 Lines are constant in all modules (just change module name)
1349     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1350         return array();
1351     }
1353     if (!$quizzes = get_all_instances_in_courses('quiz', $courses)) {
1354         return;
1355     }
1357     // Fetch some language strings outside the main loop.
1358     $strquiz = get_string('modulename', 'quiz');
1359     $strnoattempts = get_string('noattempts', 'quiz');
1361     // We want to list quizzes that are currently available, and which have a close date.
1362     // This is the same as what the lesson does, and the dabate is in MDL-10568.
1363     $now = time();
1364     foreach ($quizzes as $quiz) {
1365         if ($quiz->timeclose >= $now && $quiz->timeopen < $now) {
1366             // Give a link to the quiz, and the deadline.
1367             $str = '<div class="quiz overview">' .
1368                     '<div class="name">' . $strquiz . ': <a ' .
1369                     ($quiz->visible ? '' : ' class="dimmed"') .
1370                     ' href="' . $CFG->wwwroot . '/mod/quiz/view.php?id=' .
1371                     $quiz->coursemodule . '">' .
1372                     $quiz->name . '</a></div>';
1373             $str .= '<div class="info">' . get_string('quizcloseson', 'quiz',
1374                     userdate($quiz->timeclose)) . '</div>';
1376             // Now provide more information depending on the uers's role.
1377             $context = get_context_instance(CONTEXT_MODULE, $quiz->coursemodule);
1378             if (has_capability('mod/quiz:viewreports', $context)) {
1379                 // For teacher-like people, show a summary of the number of student attempts.
1380                 // The $quiz objects returned by get_all_instances_in_course have the necessary $cm
1381                 // fields set to make the following call work.
1382                 $str .= '<div class="info">' .
1383                         quiz_num_attempt_summary($quiz, $quiz, true) . '</div>';
1384             } else if (has_any_capability(array('mod/quiz:reviewmyattempts', 'mod/quiz:attempt'),
1385                     $context)) { // Student
1386                 // For student-like people, tell them how many attempts they have made.
1387                 if (isset($USER->id) &&
1388                         ($attempts = quiz_get_user_attempts($quiz->id, $USER->id))) {
1389                     $numattempts = count($attempts);
1390                     $str .= '<div class="info">' .
1391                             get_string('numattemptsmade', 'quiz', $numattempts) . '</div>';
1392                 } else {
1393                     $str .= '<div class="info">' . $strnoattempts . '</div>';
1394                 }
1395             } else {
1396                 // For ayone else, there is no point listing this quiz, so stop processing.
1397                 continue;
1398             }
1400             // Add the output for this quiz to the rest.
1401             $str .= '</div>';
1402             if (empty($htmlarray[$quiz->course]['quiz'])) {
1403                 $htmlarray[$quiz->course]['quiz'] = $str;
1404             } else {
1405                 $htmlarray[$quiz->course]['quiz'] .= $str;
1406             }
1407         }
1408     }
1411 /**
1412  * Return a textual summary of the number of attempts that have been made at a particular quiz,
1413  * returns '' if no attempts have been made yet, unless $returnzero is passed as true.
1414  *
1415  * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
1416  * @param object $cm the cm object. Only $cm->course, $cm->groupmode and
1417  *      $cm->groupingid fields are used at the moment.
1418  * @param bool $returnzero if false (default), when no attempts have been
1419  *      made '' is returned instead of 'Attempts: 0'.
1420  * @param int $currentgroup if there is a concept of current group where this method is being called
1421  *         (e.g. a report) pass it in here. Default 0 which means no current group.
1422  * @return string a string like "Attempts: 123", "Attemtps 123 (45 from your groups)" or
1423  *          "Attemtps 123 (45 from this group)".
1424  */
1425 function quiz_num_attempt_summary($quiz, $cm, $returnzero = false, $currentgroup = 0) {
1426     global $DB, $USER;
1427     $numattempts = $DB->count_records('quiz_attempts', array('quiz'=> $quiz->id, 'preview'=>0));
1428     if ($numattempts || $returnzero) {
1429         if (groups_get_activity_groupmode($cm)) {
1430             $a->total = $numattempts;
1431             if ($currentgroup) {
1432                 $a->group = $DB->count_records_sql('SELECT count(1) FROM ' .
1433                         '{quiz_attempts} qa JOIN ' .
1434                         '{groups_members} gm ON qa.userid = gm.userid ' .
1435                         'WHERE quiz = ? AND preview = 0 AND groupid = ?',
1436                         array($quiz->id, $currentgroup));
1437                 return get_string('attemptsnumthisgroup', 'quiz', $a);
1438             } else if ($groups = groups_get_all_groups($cm->course, $USER->id, $cm->groupingid)) {
1439                 list($usql, $params) = $DB->get_in_or_equal(array_keys($groups));
1440                 $a->group = $DB->count_records_sql('SELECT count(1) FROM ' .
1441                         '{quiz_attempts} qa JOIN ' .
1442                         '{groups_members} gm ON qa.userid = gm.userid ' .
1443                         'WHERE quiz = ? AND preview = 0 AND ' .
1444                         "groupid $usql", array_merge(array($quiz->id), $params));
1445                 return get_string('attemptsnumyourgroups', 'quiz', $a);
1446             }
1447         }
1448         return get_string('attemptsnum', 'quiz', $numattempts);
1449     }
1450     return '';
1453 /**
1454  * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link
1455  * to the quiz reports.
1456  *
1457  * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
1458  * @param object $cm the cm object. Only $cm->course, $cm->groupmode and
1459  *      $cm->groupingid fields are used at the moment.
1460  * @param object $context the quiz context.
1461  * @param bool $returnzero if false (default), when no attempts have been made
1462  *      '' is returned instead of 'Attempts: 0'.
1463  * @param int $currentgroup if there is a concept of current group where this method is being called
1464  *         (e.g. a report) pass it in here. Default 0 which means no current group.
1465  * @return string HTML fragment for the link.
1466  */
1467 function quiz_attempt_summary_link_to_reports($quiz, $cm, $context, $returnzero = false,
1468         $currentgroup = 0) {
1469     global $CFG;
1470     $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup);
1471     if (!$summary) {
1472         return '';
1473     }
1475     require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
1476     $url = new moodle_url('/mod/quiz/report.php', array(
1477             'id' => $cm->id, 'mode' => quiz_report_default_report($context)));
1478     return html_writer::link($url, $summary);
1481 /**
1482  * @param string $feature FEATURE_xx constant for requested feature
1483  * @return bool True if quiz supports feature
1484  */
1485 function quiz_supports($feature) {
1486     switch($feature) {
1487         case FEATURE_GROUPS:                  return true;
1488         case FEATURE_GROUPINGS:               return true;
1489         case FEATURE_GROUPMEMBERSONLY:        return true;
1490         case FEATURE_MOD_INTRO:               return true;
1491         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
1492         case FEATURE_GRADE_HAS_GRADE:         return true;
1493         case FEATURE_GRADE_OUTCOMES:          return true;
1494         case FEATURE_BACKUP_MOODLE2:          return true;
1496         default: return null;
1497     }
1500 /**
1501  * @return array all other caps used in module
1502  */
1503 function quiz_get_extra_capabilities() {
1504     global $CFG;
1505     require_once($CFG->libdir.'/questionlib.php');
1506     $caps = question_get_all_capabilities();
1507     $caps[] = 'moodle/site:accessallgroups';
1508     return $caps;
1511 /**
1512  * This fucntion extends the global navigation for the site.
1513  * It is important to note that you should not rely on PAGE objects within this
1514  * body of code as there is no guarantee that during an AJAX request they are
1515  * available
1516  *
1517  * @param navigation_node $quiznode The quiz node within the global navigation
1518  * @param object $course The course object returned from the DB
1519  * @param object $module The module object returned from the DB
1520  * @param object $cm The course module instance returned from the DB
1521  */
1522 function quiz_extend_navigation($quiznode, $course, $module, $cm) {
1523     global $CFG;
1525     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1527     if (has_capability('mod/quiz:view', $context)) {
1528         $url = new moodle_url('/mod/quiz/view.php', array('id'=>$cm->id));
1529         $quiznode->add(get_string('info', 'quiz'), $url, navigation_node::TYPE_SETTING,
1530                 null, null, new pix_icon('i/info', ''));
1531     }
1533     if (has_any_capability(array('mod/quiz:viewreports', 'mod/quiz:grade'), $context)) {
1534         require_once($CFG->dirroot.'/mod/quiz/report/reportlib.php');
1535         $reportlist = quiz_report_list($context);
1537         $url = new moodle_url('/mod/quiz/report.php',
1538                 array('id' => $cm->id, 'mode' => reset($reportlist)));
1539         $reportnode = $quiznode->add(get_string('results', 'quiz'), $url,
1540                 navigation_node::TYPE_SETTING,
1541                 null, null, new pix_icon('i/report', ''));
1543         foreach ($reportlist as $report) {
1544             $url = new moodle_url('/mod/quiz/report.php',
1545                     array('id' => $cm->id, 'mode' => $report));
1546             $reportnode->add(get_string($report, 'quiz_'.$report), $url,
1547                     navigation_node::TYPE_SETTING,
1548                     null, 'quiz_report_' . $report, new pix_icon('i/item', ''));
1549         }
1550     }
1553 /**
1554  * This function extends the settings navigation block for the site.
1555  *
1556  * It is safe to rely on PAGE here as we will only ever be within the module
1557  * context when this is called
1558  *
1559  * @param settings_navigation $settings
1560  * @param navigation_node $quiznode
1561  */
1562 function quiz_extend_settings_navigation($settings, $quiznode) {
1563     global $PAGE, $CFG;
1565     /**
1566      * Require {@link questionlib.php}
1567      * Included here as we only ever want to include this file if we really need to.
1568      */
1569     require_once($CFG->libdir . '/questionlib.php');
1571     if (has_capability('mod/quiz:manageoverrides', $PAGE->cm->context)) {
1572         $url = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$PAGE->cm->id));
1573         $quiznode->add(get_string('groupoverrides', 'quiz'),
1574                 new moodle_url($url, array('mode'=>'group')),
1575                 navigation_node::TYPE_SETTING, null, 'groupoverrides');
1576         $quiznode->add(get_string('useroverrides', 'quiz'),
1577                 new moodle_url($url, array('mode'=>'user')),
1578                 navigation_node::TYPE_SETTING, null, 'useroverrides');
1579     }
1581     if (has_capability('mod/quiz:manage', $PAGE->cm->context)) {
1582         $url = new moodle_url('/mod/quiz/edit.php', array('cmid'=>$PAGE->cm->id));
1583         $text = get_string('editquiz', 'quiz');
1584         $quiznode->add($text, $url, navigation_node::TYPE_SETTING, null,
1585                 'mod_quiz_edit', new pix_icon('t/edit', ''));
1586     }
1588     if (has_capability('mod/quiz:preview', $PAGE->cm->context)) {
1589         $url = new moodle_url('/mod/quiz/startattempt.php',
1590                 array('cmid'=>$PAGE->cm->id, 'sesskey'=>sesskey()));
1591         $quiznode->add(get_string('preview', 'quiz'), $url, navigation_node::TYPE_SETTING,
1592                 null, 'mod_quiz_preview', new pix_icon('t/preview', ''));
1593     }
1595     question_extend_settings_navigation($quiznode, $PAGE->cm->context)->trim_if_empty();
1598 /**
1599  * Serves the quiz files.
1600  *
1601  * @param object $course
1602  * @param object $cm
1603  * @param object $context
1604  * @param string $filearea
1605  * @param array $args
1606  * @param bool $forcedownload
1607  * @return bool false if file not found, does not return if found - justsend the file
1608  */
1609 function quiz_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
1610     global $CFG, $DB;
1612     if ($context->contextlevel != CONTEXT_MODULE) {
1613         return false;
1614     }
1616     require_login($course, false, $cm);
1618     if (!$quiz = $DB->get_record('quiz', array('id'=>$cm->instance))) {
1619         return false;
1620     }
1622     // 'intro' area is served by pluginfile.php
1623     $fileareas = array('feedback');
1624     if (!in_array($filearea, $fileareas)) {
1625         return false;
1626     }
1628     $feedbackid = (int)array_shift($args);
1629     if (!$feedback = $DB->get_record('quiz_feedback', array('id'=>$feedbackid))) {
1630         return false;
1631     }
1633     $fs = get_file_storage();
1634     $relativepath = implode('/', $args);
1635     $fullpath = "/$context->id/mod_quiz/$filearea/$feedbackid/$relativepath";
1636     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1637         return false;
1638     }
1639     send_stored_file($file, 0, 0, true);
1642 /**
1643  * Called via pluginfile.php -> question_pluginfile to serve files belonging to
1644  * a question in a question_attempt when that attempt is a quiz attempt.
1645  *
1646  * @param object $course course settings object
1647  * @param object $context context object
1648  * @param string $component the name of the component we are serving files for.
1649  * @param string $filearea the name of the file area.
1650  * @param array $args the remaining bits of the file path.
1651  * @param bool $forcedownload whether the user must be forced to download the file.
1652  * @return bool false if file not found, does not return if found - justsend the file
1653  */
1654 function mod_quiz_question_pluginfile($course, $context, $component,
1655         $filearea, $qubaid, $slot, $args, $forcedownload) {
1656     global $USER, $CFG;
1657     require_once($CFG->dirroot . '/mod/quiz/locallib.php');
1659     $attemptobj = quiz_attempt::create_from_usage_id($qubaid);
1660     require_login($attemptobj->get_courseid(), false, $attemptobj->get_cm());
1662     if ($attemptobj->is_own_attempt() && !$attemptobj->is_finished()) {
1663         // In the middle of an attempt.
1664         if (!$attemptobj->is_preview_user()) {
1665             $attemptobj->require_capability('mod/quiz:attempt');
1666         }
1667         $isreviewing = false;
1669     } else {
1670         // Reviewing an attempt.
1671         $attemptobj->check_review_capability();
1672         $isreviewing = true;
1673     }
1675     if (!$attemptobj->check_file_access($slot, $isreviewing, $context->id,
1676             $component, $filearea, $args, $forcedownload)) {
1677         send_file_not_found();
1678     }
1680     $fs = get_file_storage();
1681     $relativepath = implode('/', $args);
1682     $fullpath = "/$context->id/$component/$filearea/$relativepath";
1683     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
1684         send_file_not_found();
1685     }
1687     send_stored_file($file, 0, 0, $forcedownload);