Skip to content

Commit

Permalink
MDL-41557 Events: Fixed event data snapshot to save valid data
Browse files Browse the repository at this point in the history
  • Loading branch information
Rajesh Taneja committed Sep 13, 2013
1 parent 83f26f6 commit 3a11e2d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 57 deletions.
26 changes: 8 additions & 18 deletions course/lib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2186,7 +2186,7 @@ function move_courses($courseids, $categoryid) {
$i = 1;

list($where, $params) = $DB->get_in_or_equal($courseids);
$dbcourses = $DB->get_records_select('course', 'id ' . $where, $params);
$dbcourses = $DB->get_records_select('course', 'id ' . $where, $params, '', 'id, category, shortname, fullname');
foreach ($dbcourses as $dbcourse) {
$course = new stdClass();
$course->id = $dbcourse->id;
Expand All @@ -2200,28 +2200,19 @@ function move_courses($courseids, $categoryid) {

$DB->update_record('course', $course);

// Store the context.
// Update context, so it can be passed to event.
$context = context_course::instance($course->id);

// Update the course object we are passing to the event.
$dbcourse->category = $course->category;
$dbcourse->sortorder = $course->sortorder;
if (isset($course->visible)) {
$dbcourse->visible = $course->visible;
}
$context->update_moved($newparent);

// Trigger a course updated event.
$event = \core\event\course_updated::create(array(
'objectid' => $course->id,
'context' => $context,
'context' => context_course::instance($course->id),
'other' => array('shortname' => $dbcourse->shortname,
'fullname' => $dbcourse->fullname)
));
$event->add_record_snapshot('course', $dbcourse);
$event->set_legacy_logdata(array($course->id, 'course', 'move', 'edit.php?id=' . $course->id, $course->id));
$event->trigger();

$context->update_moved($newparent);
}
fix_course_sortorder();
cache_helper::purge_by_event('changesincourse');
Expand Down Expand Up @@ -2474,7 +2465,6 @@ function create_course($data, $editoroptions = NULL) {
'other' => array('shortname' => $course->shortname,
'fullname' => $course->fullname)
));
$event->add_record_snapshot('course', $course);
$event->trigger();

return $course;
Expand Down Expand Up @@ -2558,8 +2548,8 @@ function update_course($data, $editoroptions = NULL) {
$newparent = context_coursecat::instance($course->category);
$context->update_moved($newparent);
}

if ($movecat || (isset($data->sortorder) && $oldcourse->sortorder != $data->sortorder)) {
$fixcoursesortorder = $movecat || (isset($data->sortorder) && ($oldcourse->sortorder != $data->sortorder));
if ($fixcoursesortorder) {
fix_course_sortorder();
}

Expand All @@ -2581,11 +2571,11 @@ function update_course($data, $editoroptions = NULL) {
// Trigger a course updated event.
$event = \core\event\course_updated::create(array(
'objectid' => $course->id,
'context' => $context,
'context' => context_course::instance($course->id),
'other' => array('shortname' => $course->shortname,
'fullname' => $course->fullname)
));
$event->add_record_snapshot('course', $course);

$event->set_legacy_logdata(array($course->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id));
$event->trigger();

Expand Down
73 changes: 34 additions & 39 deletions course/tests/courselib_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1390,13 +1390,17 @@ public function test_course_delete_module() {
* Test that triggering a course_created event works as expected.
*/
public function test_course_created_event() {
global $DB;

$this->resetAfterTest();

// Catch the events.
$sink = $this->redirectEvents();

// Create the course.
$course = $this->getDataGenerator()->create_course();
// Get course from DB for comparison.
$course = $DB->get_record('course', array('id' => $course->id));

// Capture the event.
$events = $sink->get_events();
Expand All @@ -1407,7 +1411,7 @@ public function test_course_created_event() {
$this->assertInstanceOf('\core\event\course_created', $event);
$this->assertEquals('course', $event->objecttable);
$this->assertEquals($course->id, $event->objectid);
$this->assertEquals(context_course::instance($course->id)->id, $event->contextid);
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($course, $event->get_record_snapshot('course', $course->id));
$this->assertEquals('course_created', $event->get_legacy_eventname());
$this->assertEventLegacyData($course, $event);
Expand All @@ -1432,69 +1436,60 @@ public function test_course_updated_event() {
// Create a hidden category we are going to move this course to.
$categoryhidden = $this->getDataGenerator()->create_category(array('visible' => 0));

// Catch the update events.
// Update course and catch course_updated event.
$sink = $this->redirectEvents();

// Keep track of the old sortorder.
$sortorder = $course->sortorder;

// Call update_course which will trigger a course_updated event.
update_course($course);

// Return the updated course information from the DB.
$updatedcourse = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);

// Now move the course to the category, this will also trigger an event.
move_courses(array($course->id), $category->id);

// Return the moved course information from the DB.
$movedcourse = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);

// Now move the course to the hidden category, this will also trigger an event.
move_courses(array($course->id), $categoryhidden->id);

// Return the moved course information from the DB.
$movedcoursehidden = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);

// Now we want to set the sortorder back to what it was before fix_course_sortorder() was called. The reason for
// this is because update_course() and move_courses() call fix_course_sortorder() which alters the sort order in
// the DB, but it does not set the value of the sortorder for the course object passed to the event.
$updatedcourse->sortorder = $sortorder;
$movedcourse->sortorder = $category->sortorder + MAX_COURSES_IN_CATEGORY - 1;
$movedcoursehidden->sortorder = $categoryhidden->sortorder + MAX_COURSES_IN_CATEGORY - 1;

// Capture the events.
$events = $sink->get_events();
$sink->close();

// Validate the events.
$event = $events[0];
// Get updated course information from the DB.
$updatedcourse = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);
// Validate event.
$event = array_shift($events);
$this->assertInstanceOf('\core\event\course_updated', $event);
$this->assertEquals('course', $event->objecttable);
$this->assertEquals($updatedcourse->id, $event->objectid);
$this->assertEquals(context_course::instance($updatedcourse->id)->id, $event->contextid);
$this->assertEquals($updatedcourse, $event->get_record_snapshot('course', $updatedcourse->id));
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($updatedcourse, $event->get_record_snapshot('course', $event->objectid));
$this->assertEquals('course_updated', $event->get_legacy_eventname());
$this->assertEventLegacyData($updatedcourse, $event);
$expectedlog = array($updatedcourse->id, 'course', 'update', 'edit.php?id=' . $course->id, $course->id);
$this->assertEventLegacyLogData($expectedlog, $event);

$event = $events[1];
// Move course and catch course_updated event.
$sink = $this->redirectEvents();
move_courses(array($course->id), $category->id);
$events = $sink->get_events();
$sink->close();

// Return the moved course information from the DB.
$movedcourse = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);
// Validate event.
$event = array_shift($events);
$this->assertInstanceOf('\core\event\course_updated', $event);
$this->assertEquals('course', $event->objecttable);
$this->assertEquals($movedcourse->id, $event->objectid);
$this->assertEquals(context_course::instance($movedcourse->id)->id, $event->contextid);
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($movedcourse, $event->get_record_snapshot('course', $movedcourse->id));
$this->assertEquals('course_updated', $event->get_legacy_eventname());
$this->assertEventLegacyData($movedcourse, $event);
$expectedlog = array($movedcourse->id, 'course', 'move', 'edit.php?id=' . $movedcourse->id, $movedcourse->id);
$this->assertEventLegacyLogData($expectedlog, $event);

$event = $events[2];
// Move course to hidden category and catch course_updated event.
$sink = $this->redirectEvents();
move_courses(array($course->id), $categoryhidden->id);
$events = $sink->get_events();
$sink->close();

// Return the moved course information from the DB.
$movedcoursehidden = $DB->get_record('course', array('id' => $course->id), '*', MUST_EXIST);
// Validate event.
$event = array_shift($events);
$this->assertInstanceOf('\core\event\course_updated', $event);
$this->assertEquals('course', $event->objecttable);
$this->assertEquals($movedcoursehidden->id, $event->objectid);
$this->assertEquals(context_course::instance($movedcoursehidden->id)->id, $event->contextid);
$this->assertEquals(context_course::instance($course->id), $event->get_context());
$this->assertEquals($movedcoursehidden, $event->get_record_snapshot('course', $movedcoursehidden->id));
$this->assertEquals('course_updated', $event->get_legacy_eventname());
$this->assertEventLegacyData($movedcoursehidden, $event);
Expand Down

0 comments on commit 3a11e2d

Please sign in to comment.