mirror of
https://github.com/moodle/moodle.git
synced 2025-02-22 19:06:51 +01:00
a29bcf7819
Instead of silently defaulting to SITEID when courseid (coming from message_send()/\core\message\manager::send_message()) is missing, now a debugging message is shown to allow developers to fix their messages to, always, include courseid. Raw creation of events via message_sent::create() missing other[courseid] leads to coding exception since now (there shouldn't be any legacy use, as far as they are always created via create_from_ids() when sending a message. Updated upgrade.txt notes a little bit, added references the 3.6 final deprecation issue (MDL-55449) and covered with unit tests.
437 lines
17 KiB
PHP
437 lines
17 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Events tests.
|
|
*
|
|
* @package core_message
|
|
* @category test
|
|
* @copyright 2014 Mark Nelson <markn@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
class core_message_events_testcase extends advanced_testcase {
|
|
|
|
/**
|
|
* Test set up.
|
|
*
|
|
* This is executed before running any test in this file.
|
|
*/
|
|
public function setUp() {
|
|
$this->resetAfterTest();
|
|
}
|
|
|
|
/**
|
|
* Test the message contact added event.
|
|
*/
|
|
public function test_message_contact_added() {
|
|
// Set this user as the admin.
|
|
$this->setAdminUser();
|
|
|
|
// Create a user to add to the admin's contact list.
|
|
$user = $this->getDataGenerator()->create_user();
|
|
|
|
// Trigger and capture the event when adding a contact.
|
|
$sink = $this->redirectEvents();
|
|
message_add_contact($user->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_contact_added', $event);
|
|
$this->assertEquals(context_user::instance(2), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'add contact', 'index.php?user1=' . $user->id .
|
|
'&user2=2', $user->id);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
}
|
|
|
|
/**
|
|
* Test the message contact removed event.
|
|
*/
|
|
public function test_message_contact_removed() {
|
|
// Set this user as the admin.
|
|
$this->setAdminUser();
|
|
|
|
// Create a user to add to the admin's contact list.
|
|
$user = $this->getDataGenerator()->create_user();
|
|
|
|
// Add the user to the admin's contact list.
|
|
message_add_contact($user->id);
|
|
|
|
// Trigger and capture the event when adding a contact.
|
|
$sink = $this->redirectEvents();
|
|
message_remove_contact($user->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_contact_removed', $event);
|
|
$this->assertEquals(context_user::instance(2), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'remove contact', 'index.php?user1=' . $user->id .
|
|
'&user2=2', $user->id);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
}
|
|
|
|
/**
|
|
* Test the message contact blocked event.
|
|
*/
|
|
public function test_message_contact_blocked() {
|
|
// Set this user as the admin.
|
|
$this->setAdminUser();
|
|
|
|
// Create a user to add to the admin's contact list.
|
|
$user = $this->getDataGenerator()->create_user();
|
|
$user2 = $this->getDataGenerator()->create_user();
|
|
|
|
// Add the user to the admin's contact list.
|
|
message_add_contact($user->id);
|
|
|
|
// Trigger and capture the event when blocking a contact.
|
|
$sink = $this->redirectEvents();
|
|
message_block_contact($user->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_contact_blocked', $event);
|
|
$this->assertEquals(context_user::instance(2), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'block contact', 'index.php?user1=' . $user->id . '&user2=2', $user->id);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
|
|
// Make sure that the contact blocked event is not triggered again.
|
|
$sink->clear();
|
|
message_block_contact($user->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
$this->assertEmpty($event);
|
|
// Make sure that we still have 1 blocked user.
|
|
$this->assertEquals(1, \core_message\api::count_blocked_users());
|
|
|
|
// Now blocking a user that is not a contact.
|
|
$sink->clear();
|
|
message_block_contact($user2->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_contact_blocked', $event);
|
|
$this->assertEquals(context_user::instance(2), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'block contact', 'index.php?user1=' . $user2->id . '&user2=2', $user2->id);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
}
|
|
|
|
/**
|
|
* Test the message contact unblocked event.
|
|
*/
|
|
public function test_message_contact_unblocked() {
|
|
// Set this user as the admin.
|
|
$this->setAdminUser();
|
|
|
|
// Create a user to add to the admin's contact list.
|
|
$user = $this->getDataGenerator()->create_user();
|
|
|
|
// Add the user to the admin's contact list.
|
|
message_add_contact($user->id);
|
|
|
|
// Block the user.
|
|
message_block_contact($user->id);
|
|
// Make sure that we have 1 blocked user.
|
|
$this->assertEquals(1, \core_message\api::count_blocked_users());
|
|
|
|
// Trigger and capture the event when unblocking a contact.
|
|
$sink = $this->redirectEvents();
|
|
message_unblock_contact($user->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_contact_unblocked', $event);
|
|
$this->assertEquals(context_user::instance(2), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'unblock contact', 'index.php?user1=' . $user->id . '&user2=2', $user->id);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
|
|
// Make sure that we have no blocked users.
|
|
$this->assertEmpty(\core_message\api::count_blocked_users());
|
|
|
|
// Make sure that the contact unblocked event is not triggered again.
|
|
$sink->clear();
|
|
message_unblock_contact($user->id);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
$this->assertEmpty($event);
|
|
|
|
// Make sure that we still have no blocked users.
|
|
$this->assertEmpty(\core_message\api::count_blocked_users());
|
|
}
|
|
|
|
/**
|
|
* Test the message sent event.
|
|
*
|
|
* We can not use the message_send() function in the unit test to check that the event was fired as there is a
|
|
* conditional check to ensure a fake message is sent during unit tests when calling that particular function.
|
|
*/
|
|
public function test_message_sent() {
|
|
$event = \core\event\message_sent::create(array(
|
|
'userid' => 1,
|
|
'context' => context_system::instance(),
|
|
'relateduserid' => 2,
|
|
'other' => array(
|
|
'messageid' => 3,
|
|
'courseid' => 4
|
|
)
|
|
));
|
|
|
|
// Trigger and capturing the event.
|
|
$sink = $this->redirectEvents();
|
|
$event->trigger();
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_sent', $event);
|
|
$this->assertEquals(context_system::instance(), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'write', 'index.php?user=1&id=2&history=1#m3', 1);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
$this->assertEquals(3, $event->other['messageid']);
|
|
$this->assertEquals(4, $event->other['courseid']);
|
|
}
|
|
|
|
public function test_mesage_sent_without_other_courseid() {
|
|
|
|
// Creating a message_sent event without other[courseid] leads to exception.
|
|
$this->expectException('coding_exception');
|
|
$this->expectExceptionMessage('The \'courseid\' value must be set in other');
|
|
|
|
$event = \core\event\message_sent::create(array(
|
|
'userid' => 1,
|
|
'context' => context_system::instance(),
|
|
'relateduserid' => 2,
|
|
'other' => array(
|
|
'messageid' => 3,
|
|
)
|
|
));
|
|
}
|
|
|
|
public function test_mesage_sent_via_create_from_ids() {
|
|
// Containing courseid.
|
|
$event = \core\event\message_sent::create_from_ids(1, 2, 3, 4);
|
|
|
|
// Trigger and capturing the event.
|
|
$sink = $this->redirectEvents();
|
|
$event->trigger();
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_sent', $event);
|
|
$this->assertEquals(context_system::instance(), $event->get_context());
|
|
$expected = array(SITEID, 'message', 'write', 'index.php?user=1&id=2&history=1#m3', 1);
|
|
$this->assertEventLegacyLogData($expected, $event);
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
$this->assertEquals(3, $event->other['messageid']);
|
|
$this->assertEquals(4, $event->other['courseid']);
|
|
}
|
|
|
|
public function test_mesage_sent_via_create_from_ids_without_other_courseid() {
|
|
|
|
// Creating a message_sent event without courseid leads to debugging + SITEID.
|
|
// TODO: MDL-55449 Ensure this leads to exception instead of debugging in Moodle 3.6.
|
|
$event = \core\event\message_sent::create_from_ids(1, 2, 3);
|
|
|
|
// Trigger and capturing the event.
|
|
$sink = $this->redirectEvents();
|
|
$event->trigger();
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
$this->assertDebuggingCalled();
|
|
$this->assertEquals(SITEID, $event->other['courseid']);
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Test the message viewed event.
|
|
*/
|
|
public function test_message_viewed() {
|
|
global $DB;
|
|
|
|
// Create a message to mark as read.
|
|
$message = new stdClass();
|
|
$message->useridfrom = '1';
|
|
$message->useridto = '2';
|
|
$message->subject = 'Subject';
|
|
$message->message = 'Message';
|
|
$message->id = $DB->insert_record('message', $message);
|
|
|
|
// Trigger and capture the event.
|
|
$sink = $this->redirectEvents();
|
|
message_mark_message_read($message, time());
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_viewed', $event);
|
|
$this->assertEquals(context_user::instance(2), $event->get_context());
|
|
$url = new moodle_url('/message/index.php', array('user1' => $event->userid, 'user2' => $event->relateduserid));
|
|
$this->assertEquals($url, $event->get_url());
|
|
}
|
|
|
|
/**
|
|
* Test the message deleted event.
|
|
*/
|
|
public function test_message_deleted() {
|
|
global $DB;
|
|
|
|
// Create a message.
|
|
$message = new stdClass();
|
|
$message->useridfrom = '1';
|
|
$message->useridto = '2';
|
|
$message->subject = 'Subject';
|
|
$message->message = 'Message';
|
|
$message->timeuserfromdeleted = 0;
|
|
$message->timeusertodeleted = 0;
|
|
$message->id = $DB->insert_record('message', $message);
|
|
|
|
// Trigger and capture the event.
|
|
$sink = $this->redirectEvents();
|
|
message_delete_message($message, $message->useridfrom);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_deleted', $event);
|
|
$this->assertEquals($message->useridfrom, $event->userid); // The user who deleted it.
|
|
$this->assertEquals($message->useridto, $event->relateduserid);
|
|
$this->assertEquals('message', $event->other['messagetable']);
|
|
$this->assertEquals($message->id, $event->other['messageid']);
|
|
$this->assertEquals($message->useridfrom, $event->other['useridfrom']);
|
|
$this->assertEquals($message->useridto, $event->other['useridto']);
|
|
|
|
// Create a read message.
|
|
$message = new stdClass();
|
|
$message->useridfrom = '2';
|
|
$message->useridto = '1';
|
|
$message->subject = 'Subject';
|
|
$message->message = 'Message';
|
|
$message->timeuserfromdeleted = 0;
|
|
$message->timeusertodeleted = 0;
|
|
$message->timeread = time();
|
|
$message->id = $DB->insert_record('message_read', $message);
|
|
|
|
// Trigger and capture the event.
|
|
$sink = $this->redirectEvents();
|
|
message_delete_message($message, $message->useridto);
|
|
$events = $sink->get_events();
|
|
$event = reset($events);
|
|
|
|
// Check that the event data is valid.
|
|
$this->assertInstanceOf('\core\event\message_deleted', $event);
|
|
$this->assertEquals($message->useridto, $event->userid);
|
|
$this->assertEquals($message->useridfrom, $event->relateduserid);
|
|
$this->assertEquals('message_read', $event->other['messagetable']);
|
|
$this->assertEquals($message->id, $event->other['messageid']);
|
|
$this->assertEquals($message->useridfrom, $event->other['useridfrom']);
|
|
$this->assertEquals($message->useridto, $event->other['useridto']);
|
|
}
|
|
|
|
/**
|
|
* Test the message deleted event is fired when deleting a conversation.
|
|
*/
|
|
public function test_message_deleted_whole_conversation() {
|
|
global $DB;
|
|
|
|
// Create a message.
|
|
$message = new stdClass();
|
|
$message->useridfrom = '1';
|
|
$message->useridto = '2';
|
|
$message->subject = 'Subject';
|
|
$message->message = 'Message';
|
|
$message->timeuserfromdeleted = 0;
|
|
$message->timeusertodeleted = 0;
|
|
$message->timecreated = 1;
|
|
|
|
$messages = [];
|
|
// Send this a few times.
|
|
$messages[] = $DB->insert_record('message', $message);
|
|
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message', $message);
|
|
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message', $message);
|
|
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message', $message);
|
|
|
|
// Create a read message.
|
|
$message->timeread = time();
|
|
|
|
// Send this a few times.
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message_read', $message);
|
|
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message_read', $message);
|
|
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message_read', $message);
|
|
|
|
$message->timecreated++;
|
|
$messages[] = $DB->insert_record('message_read', $message);
|
|
|
|
// Trigger and capture the event.
|
|
$sink = $this->redirectEvents();
|
|
\core_message\api::delete_conversation(1, 2);
|
|
$events = $sink->get_events();
|
|
|
|
// Check that there were the correct number of events triggered.
|
|
$this->assertEquals(8, count($events));
|
|
|
|
// Check that the event data is valid.
|
|
$i = 0;
|
|
foreach ($events as $event) {
|
|
$table = ($i > 3) ? 'message_read' : 'message';
|
|
|
|
$this->assertInstanceOf('\core\event\message_deleted', $event);
|
|
$this->assertEquals($message->useridfrom, $event->userid);
|
|
$this->assertEquals($message->useridto, $event->relateduserid);
|
|
$this->assertEquals($table, $event->other['messagetable']);
|
|
$this->assertEquals($messages[$i], $event->other['messageid']);
|
|
$this->assertEquals($message->useridfrom, $event->other['useridfrom']);
|
|
$this->assertEquals($message->useridto, $event->other['useridto']);
|
|
|
|
$i++;
|
|
}
|
|
}
|
|
}
|