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/>.
  16
  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  */
  31
  32 require_once(dirname(__FILE__) . '/../../config.php');
  33 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
  34
  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();
  38
  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', false, PARAM_BOOL);
  45 $timeup = optional_param('timeup', 0, PARAM_BOOL); // True if form was submitted by timer.
  46 $scrollpos = optional_param('scrollpos', '', PARAM_RAW);
  47
  48 $transaction = $DB->start_delegated_transaction();
  49 $attemptobj = quiz_attempt::create($attemptid);
  50
  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(null, $page);
  61     if ($scrollpos !== '') {
  62         $nexturl->param('scrollpos', $scrollpos);
  63     }
  64 }
  65
  66 // If there is only a very small amount of time left, there is no point trying
  67 // to show the student another page of the quiz. Just finish now.
  68 $accessmanager = $attemptobj->get_access_manager($timenow);
  69 $timeleft = $accessmanager->get_time_left($attemptobj->get_attempt(), $timenow);
  70 $toolate = false;
  71 if ($timeleft !== false && $timeleft < QUIZ_MIN_TIME_TO_CONTINUE) {
  72     $timeup = true;
  73     if ($timeleft < -get_config('quiz', 'graceperiodmin')) {
  74         $toolate = true;
  75     }
  76 }
  77
  78 // Check login.
  79 require_login($attemptobj->get_course(), false, $attemptobj->get_cm());
  80 require_sesskey();
  81
  82 // Check that this attempt belongs to this user.
  83 if ($attemptobj->get_userid() != $USER->id) {
  84     throw new moodle_quiz_exception($attemptobj->get_quizobj(), 'notyourattempt');
  85 }
  86
  87 // Check capabilities.
  88 if (!$attemptobj->is_preview_user()) {
  89     $attemptobj->require_capability('mod/quiz:attempt');
  90 }
  91
  92 // If the attempt is already closed, send them to the review page.
  93 if ($attemptobj->is_finished()) {
  94     throw new moodle_quiz_exception($attemptobj->get_quizobj(),
  95             'attemptalreadyclosed', null, $attemptobj->review_url());
  96 }
  97
  98 // If time is running out, trigger the appropriate action.
  99 $becomingoverdue = false;
 100 if ($timeup) {
 101     if ($attemptobj->get_quiz()->overduehandling == 'graceperiod') {
 102         $becomingoverdue = true;
 103     } else {
 104         $finishattempt = true;
 105     }
 106 }
 107
 108 // Don't log - we will end with a redirect to a page that is logged.
 109
 110 if (!$finishattempt) {
 111     // Just process the responses for this page and go to the next page.
 112     if (!$toolate) {
 113         try {
 114             $attemptobj->process_submitted_actions($timenow, $becomingoverdue);
 115
 116         } catch (question_out_of_sequence_exception $e) {
 117             print_error('submissionoutofsequencefriendlymessage', 'question',
 118                     $attemptobj->attempt_url(null, $thispage));
 119
 120         } catch (Exception $e) {
 121             // This sucks, if we display our own custom error message, there is no way
 122             // to display the original stack trace.
 123             $debuginfo = '';
 124             if (!empty($e->debuginfo)) {
 125                 $debuginfo = $e->debuginfo;
 126             }
 127             print_error('errorprocessingresponses', 'question',
 128                     $attemptobj->attempt_url(null, $thispage), $e->getMessage(), $debuginfo);
 129         }
 130
 131     } else {
 132         // The student is too late.
 133         $attemptobj->process_going_overdue($timenow, true);
 134     }
 135
 136     $transaction->allow_commit();
 137     if ($becomingoverdue) {
 138         redirect($attemptobj->summary_url());
 139     } else {
 140         redirect($nexturl);
 141     }
 142 }
 143
 144 // Otherwise, we have been asked to finish attempt, so do that.
 145
 146 // Log the end of this attempt.
 147 add_to_log($attemptobj->get_courseid(), 'quiz', 'close attempt',
 148         'review.php?attempt=' . $attemptobj->get_attemptid(),
 149         $attemptobj->get_quizid(), $attemptobj->get_cmid());
 150
 151 // Update the quiz attempt record.
 152 try {
 153     $attemptobj->process_finish($timenow, !$toolate);
 154
 155 } catch (question_out_of_sequence_exception $e) {
 156     print_error('submissionoutofsequencefriendlymessage', 'question',
 157             $attemptobj->attempt_url(null, $thispage));
 158
 159 } catch (Exception $e) {
 160     // This sucks, if we display our own custom error message, there is no way
 161     // to display the original stack trace.
 162     $debuginfo = '';
 163     if (!empty($e->debuginfo)) {
 164         $debuginfo = $e->debuginfo;
 165     }
 166     print_error('errorprocessingresponses', 'question',
 167             $attemptobj->attempt_url(null, $thispage), $e->getMessage(), $debuginfo);
 168 }
 169
 170 // Send the user to the review page.
 171 $transaction->allow_commit();
 172 redirect($attemptobj->review_url());