first commit

mod/quiz/accessrule/openclosedate/classes/privacy/provider.php

@@ -0,0 +1,46 @@
+<?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/>.
+
+/**
+ * Privacy Subsystem implementation for quizaccess_openclosedate.
+ *
+ * @package    quizaccess_openclosedate
+ * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace quizaccess_openclosedate\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for quizaccess_openclosedate implementing null_provider.
+ *
+ * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

mod/quiz/accessrule/openclosedate/lang/en/quizaccess_openclosedate.php

@@ -0,0 +1,28 @@
+<?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/>.
+
+/**
+ * Strings for the quizaccess_openclosedate plugin.
+ *
+ * @package    quizaccess
+ * @subpackage openclosedate
+ * @copyright  2011 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['notavailable'] = 'This quiz is currently not available.';
+$string['pluginname'] = 'Open and close date access rule';
+$string['privacy:metadata'] = 'The Open and close date quiz access rule plugin does not store any personal data.';

mod/quiz/accessrule/openclosedate/rule.php

@@ -0,0 +1,85 @@
+<?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/>.
+
+use mod_quiz\local\access_rule_base;
+use mod_quiz\quiz_settings;
+
+/**
+ * A rule enforcing open and close dates.
+ *
+ * @package   quizaccess_openclosedate
+ * @copyright 2009 Tim Hunt
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class quizaccess_openclosedate extends access_rule_base {
+
+    public static function make(quiz_settings $quizobj, $timenow, $canignoretimelimits) {
+        // This rule is always used, even if the quiz has no open or close date.
+        return new self($quizobj, $timenow);
+    }
+
+    public function prevent_access() {
+        $message = get_string('notavailable', 'quizaccess_openclosedate');
+
+        if ($this->timenow < $this->quiz->timeopen) {
+            return $message;
+        }
+
+        if (!$this->quiz->timeclose) {
+            return false;
+        }
+
+        if ($this->timenow <= $this->quiz->timeclose) {
+            return false;
+        }
+
+        if ($this->quiz->overduehandling != 'graceperiod') {
+            return $message;
+        }
+
+        if ($this->timenow <= $this->quiz->timeclose + $this->quiz->graceperiod) {
+            return false;
+        }
+
+        return $message;
+    }
+
+    public function is_finished($numprevattempts, $lastattempt) {
+        return $this->quiz->timeclose && $this->timenow > $this->quiz->timeclose;
+    }
+
+    public function end_time($attempt) {
+        if ($this->quiz->timeclose) {
+            return $this->quiz->timeclose;
+        }
+        return false;
+    }
+
+    public function time_left_display($attempt, $timenow) {
+        // If this is a teacher preview after the close date, do not show
+        // the time.
+        if ($attempt->preview && $timenow > $this->quiz->timeclose) {
+            return false;
+        }
+        // Otherwise, return to the time left until the close date, providing that is
+        // less than QUIZ_SHOW_TIME_BEFORE_DEADLINE.
+        $endtime = $this->end_time($attempt);
+        if ($endtime !== false && $timenow > $endtime - QUIZ_SHOW_TIME_BEFORE_DEADLINE) {
+            return $endtime - $timenow;
+        }
+        return false;
+    }
+}

mod/quiz/accessrule/openclosedate/tests/rule_test.php

@@ -0,0 +1,190 @@
+<?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/>.
+
+namespace quizaccess_openclosedate;
+
+use mod_quiz\quiz_settings;
+use quizaccess_openclosedate;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/quiz/accessrule/openclosedate/rule.php');
+
+
+/**
+ * Unit tests for the quizaccess_openclosedate plugin.
+ *
+ * @package    quizaccess_openclosedate
+ * @category   test
+ * @copyright  2008 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class rule_test extends \basic_testcase {
+    public function test_no_dates(): void {
+        $quiz = new \stdClass();
+        $quiz->timeopen = 0;
+        $quiz->timeclose = 0;
+        $quiz->overduehandling = 'autosubmit';
+        $cm = new \stdClass();
+        $cm->id = 0;
+        $quizobj = new quiz_settings($quiz, $cm, null);
+        $attempt = new \stdClass();
+        $attempt->preview = 0;
+
+        $rule = new quizaccess_openclosedate($quizobj, 10000);
+        $this->assertFalse($rule->prevent_access());
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+        $this->assertFalse($rule->end_time($attempt));
+        $this->assertFalse($rule->time_left_display($attempt, 10000));
+        $this->assertFalse($rule->time_left_display($attempt, 0));
+
+        $rule = new quizaccess_openclosedate($quizobj, 0);
+        $this->assertFalse($rule->prevent_access());
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+        $this->assertFalse($rule->end_time($attempt));
+        $this->assertFalse($rule->time_left_display($attempt, 0));
+    }
+
+    public function test_start_date(): void {
+        $quiz = new \stdClass();
+        $quiz->timeopen = 10000;
+        $quiz->timeclose = 0;
+        $quiz->overduehandling = 'autosubmit';
+        $cm = new \stdClass();
+        $cm->id = 0;
+        $quizobj = new quiz_settings($quiz, $cm, null);
+        $attempt = new \stdClass();
+        $attempt->preview = 0;
+
+        $rule = new quizaccess_openclosedate($quizobj, 9999);
+        $this->assertEquals($rule->prevent_access(),
+            get_string('notavailable', 'quizaccess_openclosedate'));
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+        $this->assertFalse($rule->end_time($attempt));
+        $this->assertFalse($rule->time_left_display($attempt, 0));
+
+        $rule = new quizaccess_openclosedate($quizobj, 10000);
+        $this->assertFalse($rule->prevent_access());
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+        $this->assertFalse($rule->end_time($attempt));
+        $this->assertFalse($rule->time_left_display($attempt, 0));
+    }
+
+    public function test_close_date(): void {
+        $quiz = new \stdClass();
+        $quiz->timeopen = 0;
+        $quiz->timeclose = 20000;
+        $quiz->overduehandling = 'autosubmit';
+        $cm = new \stdClass();
+        $cm->id = 0;
+        $quizobj = new quiz_settings($quiz, $cm, null);
+        $attempt = new \stdClass();
+        $attempt->preview = 0;
+
+        $rule = new quizaccess_openclosedate($quizobj, 20000);
+        $this->assertFalse($rule->prevent_access());
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+
+        $this->assertEquals($rule->end_time($attempt), 20000);
+        $this->assertFalse($rule->time_left_display($attempt, 20000 - QUIZ_SHOW_TIME_BEFORE_DEADLINE));
+        $this->assertEquals($rule->time_left_display($attempt, 19900), 100);
+        $this->assertEquals($rule->time_left_display($attempt, 20000), 0);
+        $this->assertEquals($rule->time_left_display($attempt, 20100), -100);
+
+        $rule = new quizaccess_openclosedate($quizobj, 20001);
+        $this->assertEquals($rule->prevent_access(),
+            get_string('notavailable', 'quizaccess_openclosedate'));
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertTrue($rule->is_finished(0, $attempt));
+        $this->assertEquals($rule->end_time($attempt), 20000);
+        $this->assertFalse($rule->time_left_display($attempt, 20000 - QUIZ_SHOW_TIME_BEFORE_DEADLINE));
+        $this->assertEquals($rule->time_left_display($attempt, 19900), 100);
+        $this->assertEquals($rule->time_left_display($attempt, 20000), 0);
+        $this->assertEquals($rule->time_left_display($attempt, 20100), -100);
+    }
+
+    public function test_both_dates(): void {
+        $quiz = new \stdClass();
+        $quiz->timeopen = 10000;
+        $quiz->timeclose = 20000;
+        $quiz->overduehandling = 'autosubmit';
+        $cm = new \stdClass();
+        $cm->id = 0;
+        $quizobj = new quiz_settings($quiz, $cm, null);
+        $attempt = new \stdClass();
+        $attempt->preview = 0;
+
+        $rule = new quizaccess_openclosedate($quizobj, 9999);
+        $this->assertEquals($rule->prevent_access(),
+            get_string('notavailable', 'quizaccess_openclosedate'));
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+
+        $rule = new quizaccess_openclosedate($quizobj, 10000);
+        $this->assertFalse($rule->prevent_access());
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+
+        $rule = new quizaccess_openclosedate($quizobj, 20000);
+        $this->assertFalse($rule->prevent_access());
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertFalse($rule->is_finished(0, $attempt));
+
+        $rule = new quizaccess_openclosedate($quizobj, 20001);
+        $this->assertEquals($rule->prevent_access(),
+            get_string('notavailable', 'quizaccess_openclosedate'));
+        $this->assertFalse($rule->prevent_new_attempt(0, $attempt));
+        $this->assertTrue($rule->is_finished(0, $attempt));
+
+        $this->assertEquals($rule->end_time($attempt), 20000);
+        $this->assertFalse($rule->time_left_display($attempt, 20000 - QUIZ_SHOW_TIME_BEFORE_DEADLINE));
+        $this->assertEquals($rule->time_left_display($attempt, 19900), 100);
+        $this->assertEquals($rule->time_left_display($attempt, 20000), 0);
+        $this->assertEquals($rule->time_left_display($attempt, 20100), -100);
+    }
+
+    public function test_close_date_with_overdue(): void {
+        $quiz = new \stdClass();
+        $quiz->timeopen = 0;
+        $quiz->timeclose = 20000;
+        $quiz->overduehandling = 'graceperiod';
+        $quiz->graceperiod = 1000;
+        $cm = new \stdClass();
+        $cm->id = 0;
+        $quizobj = new quiz_settings($quiz, $cm, null);
+        $attempt = new \stdClass();
+        $attempt->preview = 0;
+
+        $rule = new quizaccess_openclosedate($quizobj, 20000);
+        $this->assertFalse($rule->prevent_access());
+
+        $rule = new quizaccess_openclosedate($quizobj, 20001);
+        $this->assertFalse($rule->prevent_access());
+
+        $rule = new quizaccess_openclosedate($quizobj, 21000);
+        $this->assertFalse($rule->prevent_access());
+
+        $rule = new quizaccess_openclosedate($quizobj, 21001);
+        $this->assertEquals($rule->prevent_access(),
+                get_string('notavailable', 'quizaccess_openclosedate'));
+    }
+}

mod/quiz/accessrule/openclosedate/version.php

@@ -0,0 +1,32 @@
+<?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/>.
+
+/**
+ * Version information for the quizaccess_openclosedate plugin.
+ *
+ * @package    quizaccess
+ * @subpackage openclosedate
+ * @copyright  2011 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+defined('MOODLE_INTERNAL') || die();
+
+
+$plugin->version   = 2024042200;
+$plugin->requires  = 2024041600;
+$plugin->component = 'quizaccess_openclosedate';