mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 17:02:03 +02:00
Code Issues Projects Releases Wiki Activity

MDL-82178 quiz graded notification: fix capability check

Browse Source 
Also improve the scheduled task logging
This commit is contained in:
Tim Hunt 2024-06-12 12:17:05 +01:00
parent d3ae1391ab
commit 92aa1579f9
2 changed files with 43 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
mod/quiz/classes/task/quiz_notify_attempt_manual_grading_completed.php
View File

@ -18,7 +18,7 @@ namespace mod_quiz\task;
defined('MOODLE_INTERNAL') || die();
use context_course;
use context_module;
use core_user;
use mod_quiz\quiz_attempt;
use moodle_recordset;
@ -41,11 +41,7 @@ class quiz_notify_attempt_manual_grading_completed extends \core\task\scheduled_
*/
protected $forcedtime = null;
/**
* Get name of schedule task.
*
* @return string
*/
#[\Override]
public function get_name(): string {
return get_string('notifyattemptsgradedtask', 'mod_quiz');
}
@ -75,10 +71,8 @@ class quiz_notify_attempt_manual_grading_completed extends \core\task\scheduled_
$this->forcedtime = $time;
}
/**
* Execute sending notification for manual graded attempts.
*/
public function execute() {
#[\Override]
public function execute(): void {
global $DB;
mtrace('Looking for quiz attempts which may need a graded notification sent...');
@ -94,11 +88,11 @@ class quiz_notify_attempt_manual_grading_completed extends \core\task\scheduled_
if (!$quiz || $attempt->quiz != $quiz->id) {
$quiz = $DB->get_record('quiz', ['id' => $attempt->quiz], '*', MUST_EXIST);
$cm = get_coursemodule_from_instance('quiz', $attempt->quiz);
$quizcontext = context_module::instance($cm->id);
}
if (!$course || $course->id != $quiz->course) {
$course = get_course($quiz->course);
$coursecontext = context_course::instance($quiz->course);
}
$quiz = quiz_update_effective_access($quiz, $attempt->userid);
@ -108,11 +102,13 @@ class quiz_notify_attempt_manual_grading_completed extends \core\task\scheduled_
if ($options->manualcomment == question_display_options::HIDDEN) {
// User cannot currently see the feedback, so don't message them.
// However, this may change in future, so leave them on the list.
mtrace('Not sending an email because manualcomment review option is not set.');
continue;
}
if (!has_capability('mod/quiz:emailnotifyattemptgraded', $coursecontext, $attempt->userid, false)) {
if (!has_capability('mod/quiz:emailnotifyattemptgraded', $quizcontext, $attempt->userid, false)) {
// User not eligible to get a notification. Mark them done while doing nothing.
mtrace('Not sending an email because user does not have mod/quiz:emailnotifyattemptgraded capability.');
$DB->set_field('quiz_attempts', 'gradednotificationsenttime', $attempt->timefinish, ['id' => $attempt->id]);
continue;
}

77
mod/quiz/tests/quiz_notify_attempt_manual_grading_completed_test.php
View File

@ -25,15 +25,13 @@
namespace mod_quiz;
use advanced_testcase;
use context_course;
use context_module;
use core\context;
use mod_quiz\task\quiz_notify_attempt_manual_grading_completed;
use question_engine;
use mod_quiz\quiz_settings;
use question_usage_by_activity;
use stdClass;
defined('MOODLE_INTERNAL') || die();
/**
* Class containing unit tests for the quiz notify attempt manual grading completed cron task.
@ -43,35 +41,35 @@ defined('MOODLE_INTERNAL') || die();
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcase {
/** @var \stdClass $course Test course to contain quiz. */
protected $course;
/** @var stdClass $course Test course to contain quiz. */
protected stdClass $course;
/** @var \stdClass $quiz A test quiz. */
protected $quiz;
/** @var stdClass $quiz A test quiz. */
protected stdClass $quiz;
/** @var context The quiz context. */
protected $context;
protected context $context;
/** @var stdClass The course_module. */
protected $cm;
protected stdClass $cm;
/** @var stdClass The student test. */
protected $student;
protected stdClass $student;
/** @var stdClass The teacher test. */
protected $teacher;
/** @var stdClass The student role. */
protected stdClass $studentrole;
/** @var quiz_settings Object containing the quiz settings. */
protected $quizobj;
protected quiz_settings $quizobj;
/** @var question_usage_by_activity The question usage for this quiz attempt. */
protected $quba;
protected question_usage_by_activity $quba;
/**
* Standard test setup.
*
* Create a course with a quiz and a student and a(n editing) teacher.
* the quiz has a truefalse question and an essay question.
* Create a course with a quiz and a student.
* The quiz has a truefalse question and an essay question.
*
* Also create some bits of a quiz attempt to be used later.
*/
@ -83,31 +81,21 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
// Setup test data.
$this->course = $this->getDataGenerator()->create_course();
$this->quiz = $this->getDataGenerator()->create_module('quiz', ['course' => $this->course->id]);
$this->context = context_module::instance($this->quiz->cmid);
$this->cm = get_coursemodule_from_instance('quiz', $this->quiz->id);
// Create users.
// Create a user enrolled as a student.
$this->student = self::getDataGenerator()->create_user();
$this->teacher = self::getDataGenerator()->create_user();
// Users enrolments.
$studentrole = $DB->get_record('role', ['shortname' => 'student']);
$teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher']);
// Allow student to receive messages.
$coursecontext = context_course::instance($this->course->id);
assign_capability('mod/quiz:emailnotifyattemptgraded', CAP_ALLOW, $studentrole->id, $coursecontext, true);
$this->getDataGenerator()->enrol_user($this->student->id, $this->course->id, $studentrole->id);
$this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, $teacherrole->id);
$this->studentrole = $DB->get_record('role', ['shortname' => 'student']);
$this->getDataGenerator()->enrol_user($this->student->id, $this->course->id, $this->studentrole->id);
// Make a quiz.
$quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');
$this->quiz = $quizgenerator->create_instance(['course' => $this->course->id, 'questionsperpage' => 0,
'grade' => 100.0, 'sumgrades' => 2]);
$this->context = context_module::instance($this->quiz->cmid);
$this->cm = get_coursemodule_from_instance('quiz', $this->quiz->id);
// Create a truefalse question and an essay question.
/** @var \core_question_generator $questiongenerator */
$questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
$cat = $questiongenerator->create_question_category();
$truefalse = $questiongenerator->create_question('truefalse', null, ['category' => $cat->id]);
@ -131,7 +119,7 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
$timenow = time();
// Create an attempt to be completely graded (one hour ago).
$attempt1 = quiz_create_attempt($this->quizobj, 1, null, $timenow - HOURSECS, false, $this->student->id);
$attempt1 = quiz_create_attempt($this->quizobj, 1, false, $timenow - HOURSECS, false, $this->student->id);
quiz_start_new_attempt($this->quizobj, $this->quba, $attempt1, 1, $timenow - HOURSECS);
quiz_attempt_save_started($this->quizobj, $this->quba, $attempt1);
@ -149,6 +137,8 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
$update->id = $attemptobj1->get_attemptid();
$update->timemodified = $timenow;
$update->sumgrades = $attemptobj1->get_question_usage()->get_total_mark();
$update->gradednotificationsenttime = null; // Processfinish detects the notification is not required, so sets this.
// Unset to allow testing of our logic.
$DB->update_record('quiz_attempts', $update);
$attemptobj1->get_quizobj()->get_grade_calculator()->recompute_final_grade();
@ -172,7 +162,7 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
$timenow = time();
// Create an attempt which won't be graded (1 hour ago).
$attempt2 = quiz_create_attempt($this->quizobj, 2, null, $timenow - HOURSECS, false, $this->student->id);
$attempt2 = quiz_create_attempt($this->quizobj, 2, false, $timenow - HOURSECS, false, $this->student->id);
quiz_start_new_attempt($this->quizobj, $this->quba, $attempt2, 2, $timenow - HOURSECS);
quiz_attempt_save_started($this->quizobj, $this->quba, $attempt2);
@ -198,13 +188,13 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
// Create an attempt for a user without the capability.
$timenow = time();
$attempt = quiz_create_attempt($this->quizobj, 3, null, $timenow, false, $this->teacher->id);
$attempt = quiz_create_attempt($this->quizobj, 3, false, $timenow, false, $this->student->id);
quiz_start_new_attempt($this->quizobj, $this->quba, $attempt, 3, $timenow - HOURSECS);
quiz_attempt_save_started($this->quizobj, $this->quba, $attempt);
// Process some responses and submit.
$attemptobj = quiz_attempt::create($attempt->id);
$tosubmit = [2 => ['answer' => 'Answer of teacher.', 'answerformat' => FORMAT_HTML]];
$tosubmit = [2 => ['answer' => 'Essay answer.', 'answerformat' => FORMAT_HTML]];
$attemptobj->process_submitted_actions($timenow - 30 * MINSECS, false, $tosubmit);
$attemptobj->process_finish($timenow - 20 * MINSECS, false);
@ -216,15 +206,16 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
$update->id = $attemptobj->get_attemptid();
$update->timemodified = $timenow;
$update->sumgrades = $attemptobj->get_question_usage()->get_total_mark();
$update->gradednotificationsenttime = null; // Processfinish detects the notification is not required, so sets this.
// Unset to allow testing of our logic.
$DB->update_record('quiz_attempts', $update);
$attemptobj->get_quizobj()->get_grade_calculator()->recompute_final_grade();
// Run the quiz notify attempt manual graded task.
ob_start();
$this->expectOutputRegex("~Not sending an email because user does not have mod/quiz:emailnotifyattemptgraded capability.~");
$task = new quiz_notify_attempt_manual_grading_completed();
$task->set_time_for_testing($timenow + 5 * HOURSECS + 1);
$task->execute();
ob_get_clean();
$attemptobj = quiz_attempt::create($attempt->id);
$this->assertEquals($attemptobj->get_attempt()->timefinish, $attemptobj->get_attempt()->gradednotificationsenttime);
@ -236,9 +227,12 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
public function test_notify_manual_grading_completed_task_with_capability() {
global $DB;
// Allow student to receive messages.
assign_capability('mod/quiz:emailnotifyattemptgraded', CAP_ALLOW, $this->studentrole->id, $this->context, true);
// Create an attempt with capability.
$timenow = time();
$attempt = quiz_create_attempt($this->quizobj, 4, null, $timenow, false, $this->student->id);
$attempt = quiz_create_attempt($this->quizobj, 4, false, $timenow, false, $this->student->id);
quiz_start_new_attempt($this->quizobj, $this->quba, $attempt, 4, $timenow - HOURSECS);
quiz_attempt_save_started($this->quizobj, $this->quba, $attempt);
@ -260,11 +254,10 @@ class quiz_notify_attempt_manual_grading_completed_test extends advanced_testcas
$attemptobj->get_quizobj()->get_grade_calculator()->recompute_final_grade();
// Run the quiz notify attempt manual graded task.
ob_start();
$this->expectOutputRegex("~Sending email to user {$this->student->id}~");
$task = new quiz_notify_attempt_manual_grading_completed();
$task->set_time_for_testing($timenow + 5 * HOURSECS + 1);
$task->execute();
ob_get_clean();
$attemptobj = quiz_attempt::create($attempt->id);