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

MDL-63134 mod_chat: Add userid param to mod_chat calendar callbacks

Browse Source
This commit is contained in:
Shamim Rezaie 2019-02-11 15:48:14 +11:00
parent 694513e2fe
commit 46b495fdc4
2 changed files with 236 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
mod/chat/lib.php
View File

@ -1449,16 +1449,25 @@ function chat_view($chat, $course, $cm, $context) {
*
* @param calendar_event $event
* @param \core_calendar\action_factory $factory
* @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default).
* @return \core_calendar\local\event\entities\action_interface|null
*/
function mod_chat_core_calendar_provide_event_action(calendar_event $event,
\core_calendar\action_factory $factory) {
global $DB;
\core_calendar\action_factory $factory,
int $userid = 0) {
global $USER, $DB;
$cm = get_fast_modinfo($event->courseid)->instances['chat'][$event->instance];
if ($userid) {
$user = core_user::get_user($userid, 'id, timezone');
} else {
$user = $USER;
}
$cm = get_fast_modinfo($event->courseid, $user->id)->instances['chat'][$event->instance];
$chattime = $DB->get_field('chat', 'chattime', array('id' => $event->instance));
$chattimemidnight = usergetmidnight($chattime);
$todaymidnight = usergetmidnight(time());
$usertimezone = core_date::get_user_timezone($user);
$chattimemidnight = usergetmidnight($chattime, $usertimezone);
$todaymidnight = usergetmidnight(time(), $usertimezone);
if ($chattime < $todaymidnight) {
// The chat is before today. Do not show at all.

222
mod/chat/tests/lib_test.php
View File

@ -62,6 +62,38 @@ class mod_chat_lib_testcase extends advanced_testcase {
$this->assertNull($actionevent);
}
public function test_chat_core_calendar_provide_event_action_chattime_event_yesterday_for_user() {
global $CFG;
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Enrol a student in the course.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a chat.
$chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id,
'chattime' => time() - DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $chat->id, CHAT_EVENT_TYPE_CHATTIME);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users have mod/chat:view capability by default.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_chat_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event is not shown at all.
$this->assertNull($actionevent);
}
public function test_chat_core_calendar_provide_event_action_chattime_event_today() {
$this->setAdminUser();
@ -89,6 +121,42 @@ class mod_chat_lib_testcase extends advanced_testcase {
$this->assertTrue($actionevent->is_actionable());
}
public function test_chat_core_calendar_provide_event_action_chattime_event_today_for_user() {
global $CFG;
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Enrol a student in the course.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a chat.
$chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id,
'chattime' => usergetmidnight(time())));
// Create a calendar event.
$event = $this->create_action_event($course->id, $chat->id, CHAT_EVENT_TYPE_CHATTIME);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users have mod/chat:view capability by default.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_chat_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('enterchat', 'chat'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_chat_core_calendar_provide_event_action_chattime_event_tonight() {
$this->setAdminUser();
@ -116,6 +184,42 @@ class mod_chat_lib_testcase extends advanced_testcase {
$this->assertTrue($actionevent->is_actionable());
}
public function test_chat_core_calendar_provide_event_action_chattime_event_tonight_for_user() {
global $CFG;
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Enrol a student in the course.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a chat.
$chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id,
'chattime' => usergetmidnight(time()) + (23 * HOURSECS)));
// Create a calendar event.
$event = $this->create_action_event($course->id, $chat->id, CHAT_EVENT_TYPE_CHATTIME);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users have mod/chat:view capability by default.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_chat_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('enterchat', 'chat'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertTrue($actionevent->is_actionable());
}
public function test_chat_core_calendar_provide_event_action_chattime_event_tomorrow() {
$this->setAdminUser();
@ -143,6 +247,124 @@ class mod_chat_lib_testcase extends advanced_testcase {
$this->assertFalse($actionevent->is_actionable());
}
public function test_chat_core_calendar_provide_event_action_chattime_event_tomorrow_for_user() {
global $CFG;
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
// Enrol a student in the course.
$student = $this->getDataGenerator()->create_and_enrol($course, 'student');
// Create a chat.
$chat = $this->getDataGenerator()->create_module('chat', array('course' => $course->id,
'chattime' => time() + DAYSECS));
// Create a calendar event.
$event = $this->create_action_event($course->id, $chat->id, CHAT_EVENT_TYPE_CHATTIME);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users have mod/chat:view capability by default.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for the student.
$actionevent = mod_chat_core_calendar_provide_event_action($event, $factory, $student->id);
// Confirm the event was decorated.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent);
$this->assertEquals(get_string('enterchat', 'chat'), $actionevent->get_name());
$this->assertInstanceOf('moodle_url', $actionevent->get_url());
$this->assertEquals(1, $actionevent->get_item_count());
$this->assertFalse($actionevent->is_actionable());
}
public function test_chat_core_calendar_provide_event_action_chattime_event_different_timezones() {
global $CFG;
$this->setAdminUser();
// Create a course.
$course = $this->getDataGenerator()->create_course();
$hour = gmdate('H');
// This could have been much easier if MDL-37327 were implemented.
// We don't know when this test is being ran and there is no standard way to
// mock the time() function (MDL-37327 to handle that).
if ($hour < 10) {
$timezone1 = 'Europe/London'; // GMT or GMT +01:00.
$timezone2 = 'Pacific/Pago_Pago'; // GMT -11:00.
} else if ($hour < 11) {
$timezone1 = 'Pacific/Kiritimati'; // GMT +14:00.
$timezone2 = 'America/Sao_Paulo'; // GMT -03:00.
} else {
$timezone1 = 'Pacific/Kiritimati'; // GMT +14:00.
$timezone2 = 'Europe/London'; // GMT or GMT +01:00.
}
$this->setTimezone($timezone2);
// Enrol 2 students with different timezones in the course.
$student1 = $this->getDataGenerator()->create_and_enrol($course, 'student', (object)['timezone' => $timezone1]);
$student2 = $this->getDataGenerator()->create_and_enrol($course, 'student', (object)['timezone' => $timezone2]);
// Create a chat.
$chat1 = $this->getDataGenerator()->create_module('chat', array('course' => $course->id,
'chattime' => mktime(1, 0, 0))); // This is always yesterday in timezone1 time
// and always today in timezone2 time.
// Create a chat.
$chat2 = $this->getDataGenerator()->create_module('chat', array('course' => $course->id,
'chattime' => mktime(1, 0, 0) + DAYSECS)); // This is always today in timezone1 time
// and always tomorrow in timezone2 time.
// Create calendar events for the 2 chats above.
$event1 = $this->create_action_event($course->id, $chat1->id, CHAT_EVENT_TYPE_CHATTIME);
$event2 = $this->create_action_event($course->id, $chat2->id, CHAT_EVENT_TYPE_CHATTIME);
// Now, log out.
$CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users have mod/chat:view capability by default.
$this->setUser();
// Create an action factory.
$factory = new \core_calendar\action_factory();
// Decorate action event for student1.
$actionevent11 = mod_chat_core_calendar_provide_event_action($event1, $factory, $student1->id);
$actionevent12 = mod_chat_core_calendar_provide_event_action($event1, $factory, $student2->id);
$actionevent21 = mod_chat_core_calendar_provide_event_action($event2, $factory, $student1->id);
$actionevent22 = mod_chat_core_calendar_provide_event_action($event2, $factory, $student2->id);
// Confirm event1 is not shown to student1 at all.
$this->assertNull($actionevent11);
// Confirm event1 was decorated for student2 and it is actionable.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent12);
$this->assertEquals(get_string('enterchat', 'chat'), $actionevent12->get_name());
$this->assertInstanceOf('moodle_url', $actionevent12->get_url());
$this->assertEquals(1, $actionevent12->get_item_count());
$this->assertTrue($actionevent12->is_actionable());
// Confirm event2 was decorated for student1 and it is actionable.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent21);
$this->assertEquals(get_string('enterchat', 'chat'), $actionevent21->get_name());
$this->assertInstanceOf('moodle_url', $actionevent21->get_url());
$this->assertEquals(1, $actionevent21->get_item_count());
$this->assertTrue($actionevent21->is_actionable());
// Confirm event2 was decorated for student2 and it is not actionable.
$this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent22);
$this->assertEquals(get_string('enterchat', 'chat'), $actionevent22->get_name());
$this->assertInstanceOf('moodle_url', $actionevent22->get_url());
$this->assertEquals(1, $actionevent22->get_item_count());
$this->assertFalse($actionevent22->is_actionable());
}
/**
* Test for chat_get_sessions().
*/