79da3010512793c2461e620f1f7f9999d098cb3c
[moodle.git] / mod / quiz / processattempt.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  * This page deals with processing responses during an attempt at a quiz.
19  *
20  * People will normally arrive here from a form submission on attempt.php or
21  * summary.php, and once the responses are processed, they will be redirected to
22  * attempt.php or summary.php.
23  *
24  * This code used to be near the top of attempt.php, if you are looking for CVS history.
25  *
26  * @package    mod
27  * @subpackage quiz
28  * @copyright  2009 Tim Hunt
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 require_once(dirname(__FILE__) . '/../../config.php');
33 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
35 // Remember the current time as the time any responses were submitted
36 // (so as to make sure students don't get penalized for slow processing on this page)
37 $timenow = time();
39 // Get submitted parameters.
40 $attemptid = required_param('attempt', PARAM_INT);
41 $next = optional_param('next', false, PARAM_BOOL);
42 $thispage = optional_param('thispage', 0, PARAM_INT);
43 $nextpage = optional_param('nextpage', 0, PARAM_INT);
44 $finishattempt = optional_param('finishattempt', 0, PARAM_BOOL);
45 $timeup = optional_param('timeup', 0, PARAM_BOOL); // True if form was submitted by timer.
46 $scrollpos = optional_param('scrollpos', '', PARAM_RAW);
48 $transaction = $DB->start_delegated_transaction();
49 $attemptobj = quiz_attempt::create($attemptid);
51 // Set $nexturl now.
52 if ($next) {
53     $page = $nextpage;
54 } else {
55     $page = $thispage;
56 }
57 if ($page == -1) {
58     $nexturl = $attemptobj->summary_url();
59 } else {
60     $nexturl = $attemptobj->attempt_url(0, $page);
61     if ($scrollpos !== '') {
62         $nexturl->param('scrollpos', $scrollpos);
63     }
64 }
66 // We treat automatically closed attempts just like normally closed attempts
67 if ($timeup) {
68     $finishattempt = 1;
69 }
71 // Check login.
72 require_login($attemptobj->get_course(), false, $attemptobj->get_cm());
73 require_sesskey();
75 // Check that this attempt belongs to this user.
76 if ($attemptobj->get_userid() != $USER->id) {
77     throw new moodle_quiz_exception($attemptobj->get_quizobj(), 'notyourattempt');
78 }
80 // Check capabilities.
81 if (!$attemptobj->is_preview_user()) {
82     $attemptobj->require_capability('mod/quiz:attempt');
83 }
85 // If the attempt is already closed, send them to the review page.
86 if ($attemptobj->is_finished()) {
87     throw new moodle_quiz_exception($attemptobj->get_quizobj(),
88             'attemptalreadyclosed', null, $attemptobj->review_url());
89 }
91 // Don't log - we will end with a redirect to a page that is logged.
93 if (!$finishattempt) {
94     // Just process the responses for this page and go to the next page.
95     try {
96         $attemptobj->process_all_actions($timenow);
97     } catch (question_out_of_sequence_exception $e) {
98         print_error('submissionoutofsequencefriendlymessage', 'question',
99                 $attemptobj->attempt_url(0, $thispage));
100     }
101     $transaction->allow_commit();
102     redirect($nexturl);
105 // Otherwise, we have been asked to finish attempt, so do that.
107 // Log the end of this attempt.
108 add_to_log($attemptobj->get_courseid(), 'quiz', 'close attempt',
109         'review.php?attempt=' . $attemptobj->get_attemptid(),
110         $attemptobj->get_quizid(), $attemptobj->get_cmid());
112 // Update the quiz attempt record.
113 $attemptobj->finish_attempt($timenow);
115 // Send the user to the review page.
116 $transaction->allow_commit();
117 redirect($attemptobj->review_url());