moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 02:16:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-60062 calendar: remove validate_event_timestart callback

Browse source
This commit is contained in:
Ryan Wyllie 2017-10-30 08:15:10 +00:00
parent 9aac9f7074
commit 478b1d194f
12 changed files with 459 additions and 1062 deletions
Download patch file Download diff file Expand all files Collapse all files

89
mod/assign/lib.php
View file

@ -1947,30 +1947,17 @@ function mod_assign_core_calendar_event_action_shows_item_count(calendar_event $
* ]
*
* @param calendar_event $event The calendar event to get the time range for
* @param stdClass|null $instance The module instance to get the range from
* @param stdClass $instance The module instance to get the range from
*/
function mod_assign_core_calendar_get_valid_event_timestart_range(\calendar_event $event, \stdClass $instance = null) {
global $CFG, $DB;
function mod_assign_core_calendar_get_valid_event_timestart_range(\calendar_event $event, \stdClass $instance) {
global $CFG;
require_once($CFG->dirroot . '/mod/assign/locallib.php');
if (!$instance) {
$instance = $DB->get_record('assign', ['id' => $event->instance]);
}
$coursemodule = get_coursemodule_from_instance('assign',
$event->instance,
$event->courseid,
false,
MUST_EXIST);
if (empty($coursemodule)) {
// If we don't have a course module yet then it likely means
// the activity is still being set up. In this case there is
// nothing for us to do anyway.
return;
}
$courseid = $event->courseid;
$modulename = $event->modulename;
$instanceid = $event->instance;
$coursemodule = get_fast_modinfo($courseid)->instances[$modulename][$instanceid];
$context = context_module::instance($coursemodule->id);
$assign = new assign($context, null, null);
$assign->set_instance($instance);
@ -1978,46 +1965,15 @@ function mod_assign_core_calendar_get_valid_event_timestart_range(\calendar_even
return $assign->get_valid_calendar_event_timestart_range($event);
}
/**
* This function will check that the given event is valid for it's
* corresponding assign module instance.
*
* An exception is thrown if the event fails validation.
*
* @throws \moodle_exception
* @param \calendar_event $event
* @return bool
*/
function mod_assign_core_calendar_validate_event_timestart(\calendar_event $event) {
global $DB;
if (!isset($event->instance)) {
return;
}
// We need to read from the DB directly because course module may
// currently be getting created so it won't be in mod info yet.
$instance = $DB->get_record('assign', ['id' => $event->instance], '*', MUST_EXIST);
$timestart = $event->timestart;
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
if ($min && $timestart < $min[0]) {
throw new \moodle_exception($min[1]);
}
if ($max && $timestart > $max[0]) {
throw new \moodle_exception($max[1]);
}
}
/**
* This function will update the assign module according to the
* event that has been modified.
*
* @throws \moodle_exception
* @param \calendar_event $event
* @param stdClass $instance The module instance to get the range from
*/
function mod_assign_core_calendar_event_timestart_updated(\calendar_event $event) {
function mod_assign_core_calendar_event_timestart_updated(\calendar_event $event, \stdClass $instance) {
global $CFG, $DB;
require_once($CFG->dirroot . '/mod/assign/locallib.php');
@ -2026,19 +1982,19 @@ function mod_assign_core_calendar_event_timestart_updated(\calendar_event $event
return;
}
$coursemodule = get_coursemodule_from_instance('assign',
$event->instance,
$event->courseid,
false,
MUST_EXIST);
if (empty($coursemodule)) {
// If we don't have a course module yet then it likely means
// the activity is still being set up. In this case there is
// nothing for us to do anyway.
if ($instance->id != $event->instance) {
return;
}
if (!in_array($event->eventtype, [ASSIGN_EVENT_TYPE_DUE, ASSIGN_EVENT_TYPE_GRADINGDUE])) {
return;
}
$courseid = $event->courseid;
$modulename = $event->modulename;
$instanceid = $event->instance;
$modified = false;
$coursemodule = get_fast_modinfo($courseid)->instances[$modulename][$instanceid];
$context = context_module::instance($coursemodule->id);
// The user does not have the capability to modify this activity.
@ -2047,7 +2003,7 @@ function mod_assign_core_calendar_event_timestart_updated(\calendar_event $event
}
$assign = new assign($context, $coursemodule, null);
$modified = false;
$assign->set_instance($instance);
if ($event->eventtype == ASSIGN_EVENT_TYPE_DUE) {
// This check is in here because due date events are currently
@ -2058,26 +2014,23 @@ function mod_assign_core_calendar_event_timestart_updated(\calendar_event $event
return;
}
$instance = $assign->get_instance();
$newduedate = $event->timestart;
if ($newduedate != $instance->duedate) {
$instance->duedate = $newduedate;
$instance->timemodified = time();
$modified = true;
}
} else if ($event->eventtype == ASSIGN_EVENT_TYPE_GRADINGDUE) {
$instance = $assign->get_instance();
$newduedate = $event->timestart;
if ($newduedate != $instance->gradingduedate) {
$instance->gradingduedate = $newduedate;
$instance->timemodified = time();
$modified = true;
}
}
if ($modified) {
$instance->timemodified = time();
// Persist the assign instance changes.
$DB->update_record('assign', $instance);
$assign->update_calendar($coursemodule->id);

313
mod/assign/tests/lib_test.php
View file

@ -847,7 +847,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'eventtype' => 'SOME RANDOM EVENT'
]);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
$this->assertNull($min);
$this->assertNull($max);
}
@ -882,7 +882,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
$DB->insert_record('assign_overrides', $record);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
$this->assertNull($min);
$this->assertNull($max);
}
@ -914,7 +914,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'eventtype' => ASSIGN_EVENT_TYPE_DUE
]);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
$this->assertNull($min);
$this->assertNull($max);
}
@ -948,7 +948,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'eventtype' => ASSIGN_EVENT_TYPE_DUE
]);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
$this->assertEquals($submissionsfromdate, $min[0]);
$this->assertNotEmpty($min[1]);
$this->assertEquals($cutoffdate, $max[0]);
@ -979,7 +979,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'eventtype' => ASSIGN_EVENT_TYPE_GRADINGDUE
]);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
$this->assertNull($min);
$this->assertNull($max);
}
@ -1008,307 +1008,12 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'eventtype' => ASSIGN_EVENT_TYPE_GRADINGDUE
]);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event);
list($min, $max) = mod_assign_core_calendar_get_valid_event_timestart_range($event, $instance);
$this->assertEquals($duedate, $min[0]);
$this->assertNotEmpty($min[1]);
$this->assertNull($max);
}
/**
* Calendar events without and instance id should be ignored by the validate
* event function.
*/
public function test_mod_assign_core_calendar_validate_event_timestart_no_instance_id() {
global $CFG;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$event = new \calendar_event((object) [
'modulename' => 'assign',
'eventtype' => ASSIGN_EVENT_TYPE_DUE
]);
mod_assign_core_calendar_validate_event_timestart($event);
// The function above throws an exception so all we need to do is make sure
// it gets here and that is considered success.
$this->assertTrue(true);
}
/**
* Calendar events for an unknown instance should throw an exception.
*/
public function test_mod_assign_core_calendar_validate_event_timestart_no_instance_found() {
global $CFG;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$event = new \calendar_event((object) [
'modulename' => 'assign',
'instance' => 1234,
'eventtype' => ASSIGN_EVENT_TYPE_DUE
]);
$this->expectException('moodle_exception');
mod_assign_core_calendar_validate_event_timestart($event);
}
/**
* Assignments configured without any limits on the due date should not
* throw an exception.
*/
public function test_mod_assign_core_calendar_validate_event_timestart_no_limit() {
global $CFG, $DB;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$assign = $this->create_instance([
'duedate' => 0,
'allowsubmissionsfromdate' => 0,
'cutoffdate' => 0,
]);
$instance = $assign->get_instance();
$event = new \calendar_event((object) [
'courseid' => $instance->course,
'modulename' => 'assign',
'instance' => $instance->id,
'eventtype' => ASSIGN_EVENT_TYPE_DUE,
'timestart' => time()
]);
mod_assign_core_calendar_validate_event_timestart($event);
// The function above throws an exception so all we need to do is make sure
// it gets here and that is considered success.
$this->assertTrue(true);
}
/**
* Due date events with a timestart equal to or greater than the minimum limit
* should not throw an exception. Timestart values below the minimum limit should
* throw an exception.
*/
public function test_mod_assign_core_calendar_validate_due_event_min_limit() {
global $CFG, $DB;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$duedate = time();
$submissionsfromdate = $duedate - DAYSECS;
$cutoffdate = $duedate + DAYSECS;
$assign = $this->create_instance([
'duedate' => $duedate,
'allowsubmissionsfromdate' => $submissionsfromdate,
'cutoffdate' => $cutoffdate,
]);
$instance = $assign->get_instance();
$event = new \calendar_event((object) [
'courseid' => $instance->course,
'modulename' => 'assign',
'instance' => $instance->id,
'eventtype' => ASSIGN_EVENT_TYPE_DUE,
'timestart' => $submissionsfromdate + 1,
]);
// No exception when new time is above minimum cutoff.
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// No exception when new time is equal to minimum cutoff.
$event->timestart = $submissionsfromdate;
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// Exception when new time is earlier than minimum cutoff.
$event->timestart = $submissionsfromdate - 1;
$this->expectException('moodle_exception');
mod_assign_core_calendar_validate_event_timestart($event);
}
/**
* A due date event with a timestart less than or equal to the max limit should
* not throw an exception. A timestart greater than the max limit should throw
* an exception.
*/
public function test_mod_assign_core_calendar_validate_due_event_max_limit() {
global $CFG, $DB;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$duedate = time();
$submissionsfromdate = $duedate - DAYSECS;
$cutoffdate = $duedate + DAYSECS;
$assign = $this->create_instance([
'duedate' => $duedate,
'allowsubmissionsfromdate' => $submissionsfromdate,
'cutoffdate' => $cutoffdate,
]);
$instance = $assign->get_instance();
$event = new \calendar_event((object) [
'courseid' => $instance->course,
'modulename' => 'assign',
'instance' => $instance->id,
'eventtype' => ASSIGN_EVENT_TYPE_DUE,
'timestart' => $cutoffdate - 1,
]);
// No exception when new time is below maximum cutoff.
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// No exception when new time is equal to maximum cutoff.
$event->timestart = $cutoffdate;
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// Exception when new time is later than maximum cutoff.
$event->timestart = $submissionsfromdate - 1;
$this->expectException('moodle_exception');
mod_assign_core_calendar_validate_event_timestart($event);
}
/**
* Due date override events should not throw an exception.
*/
public function test_mod_assign_core_calendar_validate_due_event_override() {
global $CFG, $DB;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$duedate = time();
$submissionsfromdate = $duedate - DAYSECS;
$cutoffdate = $duedate + DAYSECS;
$assign = $this->create_instance([
'duedate' => $duedate,
'allowsubmissionsfromdate' => $submissionsfromdate,
'cutoffdate' => $cutoffdate,
]);
$instance = $assign->get_instance();
$userid = $this->students[0]->id;
$event = new \calendar_event((object) [
'courseid' => $instance->course,
'modulename' => 'assign',
'instance' => $instance->id,
'userid' => $userid,
'eventtype' => ASSIGN_EVENT_TYPE_DUE,
'timestart' => $duedate + (2 * DAYSECS)
]);
$record = (object) [
'assignid' => $instance->id,
'userid' => $userid,
'duedate' => $duedate + (2 * DAYSECS)
];
$DB->insert_record('assign_overrides', $record);
// No exception when dealing with an override.
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
}
/**
* Grading due date event should throw an exception if it's timestart is less than the
* assignment due date.
*/
public function test_mod_assign_core_calendar_validate_gradingdue_event_min_limit_duedate() {
global $CFG, $DB;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$duedate = time();
$submissionsfromdate = $duedate - DAYSECS;
$cutoffdate = $duedate + DAYSECS;
$assign = $this->create_instance([
'duedate' => $duedate,
'allowsubmissionsfromdate' => $submissionsfromdate,
'cutoffdate' => $cutoffdate,
]);
$instance = $assign->get_instance();
$event = new \calendar_event((object) [
'courseid' => $instance->course,
'modulename' => 'assign',
'instance' => $instance->id,
'eventtype' => ASSIGN_EVENT_TYPE_GRADINGDUE,
'timestart' => $duedate + 1,
]);
// No exception when new time is above minimum cutoff.
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// No exception when new time is equal to minimum cutoff.
$event->timestart = $duedate;
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// Exception when new time is earlier than minimum cutoff.
$event->timestart = $duedate - 1;
$this->expectException('moodle_exception');
mod_assign_core_calendar_validate_event_timestart($event);
}
/**
* Grading due date event should throw an exception if it's timestart is less than the
* submissions allowed from date if there is no due date set.
*/
public function test_mod_assign_core_calendar_validate_gradingdue_event_min_limit_submissionsfromdate() {
global $CFG, $DB;
require_once($CFG->dirroot . '/calendar/lib.php');
$this->resetAfterTest();
$this->setAdminUser();
$duedate = 0;
$submissionsfromdate = time() - DAYSECS;
$cutoffdate = time() + DAYSECS;
$assign = $this->create_instance([
'duedate' => $duedate,
'allowsubmissionsfromdate' => $submissionsfromdate,
'cutoffdate' => $cutoffdate,
]);
$instance = $assign->get_instance();
$event = new \calendar_event((object) [
'courseid' => $instance->course,
'modulename' => 'assign',
'instance' => $instance->id,
'eventtype' => ASSIGN_EVENT_TYPE_GRADINGDUE,
'timestart' => $submissionsfromdate + 1,
]);
// No exception when new time is above minimum cutoff.
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// No exception when new time is equal to minimum cutoff.
$event->timestart = $submissionsfromdate;
mod_assign_core_calendar_validate_event_timestart($event);
$this->assertTrue(true);
// Exception when new time is earlier than minimum cutoff.
$event->timestart = $submissionsfromdate - 1;
$this->expectException('moodle_exception');
mod_assign_core_calendar_validate_event_timestart($event);
}
/**
* Non due date events should not update the assignment due date.
*/
@ -1337,7 +1042,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'timestart' => $duedate + 1
]);
mod_assign_core_calendar_event_timestart_updated($event);
mod_assign_core_calendar_event_timestart_updated($event, $instance);
$newinstance = $DB->get_record('assign', ['id' => $instance->id]);
$this->assertEquals($duedate, $newinstance->duedate);
@ -1381,7 +1086,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
$DB->insert_record('assign_overrides', $record);
mod_assign_core_calendar_event_timestart_updated($event);
mod_assign_core_calendar_event_timestart_updated($event, $instance);
$newinstance = $DB->get_record('assign', ['id' => $instance->id]);
$this->assertEquals($duedate, $newinstance->duedate);
@ -1416,7 +1121,7 @@ class mod_assign_lib_testcase extends mod_assign_base_testcase {
'timestart' => $newduedate
]);
mod_assign_core_calendar_event_timestart_updated($event);
mod_assign_core_calendar_event_timestart_updated($event, $instance);
$newinstance = $DB->get_record('assign', ['id' => $instance->id]);
$this->assertEquals($newduedate, $newinstance->duedate);