Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Implementaton of the quizaccess_password plugin.
 *
 * @package    quizaccess
 * @subpackage password
 * @copyright  2011 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


defined('MOODLE_INTERNAL') || die();

require_once($CFG->dirroot . '/mod/quiz/accessrule/accessrulebase.php');


/**
 * A rule implementing the password check.
 *
 * @copyright  2009 Tim Hunt
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class quizaccess_password extends quiz_access_rule_base {

    public static function make(quiz $quizobj, $timenow, $canignoretimelimits) {
        if (empty($quizobj->get_quiz()->password)) {
            return null;
        }

        return new self($quizobj, $timenow);
    }

    public function description() {
        return get_string('requirepasswordmessage', 'quizaccess_password');
    }

    public function is_preflight_check_required($attemptid) {
        global $SESSION;
        return empty($SESSION->passwordcheckedquizzes[$this->quiz->id]);
    }

    public function add_preflight_check_form_fields(mod_quiz_preflight_check_form $quizform,
            MoodleQuickForm $mform, $attemptid) {

        $mform->addElement('header', 'passwordheader', get_string('password'));
        $mform->addElement('static', 'passwordmessage', '',
                get_string('requirepasswordmessage', 'quizaccess_password'));

        // Don't use the 'proper' field name of 'password' since that get's
        // Firefox's password auto-complete over-excited.
< $mform->addElement('password', 'quizpassword', < get_string('quizpassword', 'quizaccess_password'), array('autofocus' => 'true'));
> $mform->addElement('passwordunmask', 'quizpassword', > get_string('quizpassword', 'quizaccess_password'), ['autofocus' => 'true']);
} public function validate_preflight_check($data, $files, $errors, $attemptid) { $enteredpassword = $data['quizpassword']; if (strcmp($this->quiz->password, $enteredpassword) === 0) { return $errors; // Password is OK. } else if (isset($this->quiz->extrapasswords)) { // Group overrides may have additional passwords. foreach ($this->quiz->extrapasswords as $password) { if (strcmp($password, $enteredpassword) === 0) { return $errors; // Password is OK. } } } $errors['quizpassword'] = get_string('passworderror', 'quizaccess_password'); return $errors; } public function notify_preflight_check_passed($attemptid) { global $SESSION; $SESSION->passwordcheckedquizzes[$this->quiz->id] = true; } public function current_attempt_finished() { global $SESSION; // Clear the flag in the session that says that the user has already // entered the password for this quiz. if (!empty($SESSION->passwordcheckedquizzes[$this->quiz->id])) { unset($SESSION->passwordcheckedquizzes[$this->quiz->id]); } } }