MDL-64057 core_message: return conversations with soft-deleted users
[moodle.git] / message / tests / api_test.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Test message API.
19  *
20  * @package core_message
21  * @category test
22  * @copyright 2016 Mark Nelson <markn@moodle.com>
23  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 global $CFG;
30 require_once($CFG->dirroot . '/message/tests/messagelib_test.php');
32 use \core_message\tests\helper as testhelper;
34 /**
35  * Test message API.
36  *
37  * @package core_message
38  * @category test
39  * @copyright 2016 Mark Nelson <markn@moodle.com>
40  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class core_message_api_testcase extends core_message_messagelib_testcase {
44     public function test_mark_all_read_for_user_touser() {
45         $sender = $this->getDataGenerator()->create_user(array('firstname' => 'Test1', 'lastname' => 'User1'));
46         $recipient = $this->getDataGenerator()->create_user(array('firstname' => 'Test2', 'lastname' => 'User2'));
48         $this->send_fake_message($sender, $recipient, 'Notification', 1);
49         $this->send_fake_message($sender, $recipient, 'Notification', 1);
50         $this->send_fake_message($sender, $recipient, 'Notification', 1);
51         $this->send_fake_message($sender, $recipient);
52         $this->send_fake_message($sender, $recipient);
53         $this->send_fake_message($sender, $recipient);
55         \core_message\api::mark_all_read_for_user($recipient->id);
56         $this->assertDebuggingCalled();
57         $this->assertEquals(message_count_unread_messages($recipient), 0);
58     }
60     public function test_mark_all_read_for_user_touser_with_fromuser() {
61         $sender1 = $this->getDataGenerator()->create_user(array('firstname' => 'Test1', 'lastname' => 'User1'));
62         $sender2 = $this->getDataGenerator()->create_user(array('firstname' => 'Test3', 'lastname' => 'User3'));
63         $recipient = $this->getDataGenerator()->create_user(array('firstname' => 'Test2', 'lastname' => 'User2'));
65         $this->send_fake_message($sender1, $recipient, 'Notification', 1);
66         $this->send_fake_message($sender1, $recipient, 'Notification', 1);
67         $this->send_fake_message($sender1, $recipient, 'Notification', 1);
68         $this->send_fake_message($sender1, $recipient);
69         $this->send_fake_message($sender1, $recipient);
70         $this->send_fake_message($sender1, $recipient);
71         $this->send_fake_message($sender2, $recipient, 'Notification', 1);
72         $this->send_fake_message($sender2, $recipient, 'Notification', 1);
73         $this->send_fake_message($sender2, $recipient, 'Notification', 1);
74         $this->send_fake_message($sender2, $recipient);
75         $this->send_fake_message($sender2, $recipient);
76         $this->send_fake_message($sender2, $recipient);
78         \core_message\api::mark_all_read_for_user($recipient->id, $sender1->id);
79         $this->assertDebuggingCalled();
80         $this->assertEquals(message_count_unread_messages($recipient), 3);
81     }
83     public function test_mark_all_read_for_user_touser_with_type() {
84         $sender = $this->getDataGenerator()->create_user(array('firstname' => 'Test1', 'lastname' => 'User1'));
85         $recipient = $this->getDataGenerator()->create_user(array('firstname' => 'Test2', 'lastname' => 'User2'));
87         $this->send_fake_message($sender, $recipient, 'Notification', 1);
88         $this->send_fake_message($sender, $recipient, 'Notification', 1);
89         $this->send_fake_message($sender, $recipient, 'Notification', 1);
90         $this->send_fake_message($sender, $recipient);
91         $this->send_fake_message($sender, $recipient);
92         $this->send_fake_message($sender, $recipient);
94         \core_message\api::mark_all_read_for_user($recipient->id, 0, MESSAGE_TYPE_NOTIFICATION);
95         $this->assertDebuggingCalled();
96         $this->assertEquals(message_count_unread_messages($recipient), 3);
98         \core_message\api::mark_all_read_for_user($recipient->id, 0, MESSAGE_TYPE_MESSAGE);
99         $this->assertDebuggingCalled();
100         $this->assertEquals(message_count_unread_messages($recipient), 0);
101     }
103     /**
104      * Test count_blocked_users.
105      */
106     public function test_count_blocked_users() {
107         global $USER;
109         // Set this user as the admin.
110         $this->setAdminUser();
112         // Create user to add to the admin's block list.
113         $user1 = $this->getDataGenerator()->create_user();
114         $user2 = $this->getDataGenerator()->create_user();
116         $this->assertEquals(0, \core_message\api::count_blocked_users());
118         // Add 1 blocked user to admin's blocked user list.
119         \core_message\api::block_user($USER->id, $user1->id);
121         $this->assertEquals(0, \core_message\api::count_blocked_users($user1));
122         $this->assertEquals(1, \core_message\api::count_blocked_users());
123     }
125     /**
126      * Tests searching users in a course.
127      */
128     public function test_search_users_in_course() {
129         // Create some users.
130         $user1 = new stdClass();
131         $user1->firstname = 'User';
132         $user1->lastname = 'One';
133         $user1 = self::getDataGenerator()->create_user($user1);
135         // The person doing the search.
136         $this->setUser($user1);
138         // Second user is going to have their last access set to now, so they are online.
139         $user2 = new stdClass();
140         $user2->firstname = 'User';
141         $user2->lastname = 'Two';
142         $user2->lastaccess = time();
143         $user2 = self::getDataGenerator()->create_user($user2);
145         // Block the second user.
146         \core_message\api::block_user($user1->id, $user2->id);
148         $user3 = new stdClass();
149         $user3->firstname = 'User';
150         $user3->lastname = 'Three';
151         $user3 = self::getDataGenerator()->create_user($user3);
153         // Create a course.
154         $course1 = new stdClass();
155         $course1->fullname = 'Course';
156         $course1->shortname = 'One';
157         $course1 = $this->getDataGenerator()->create_course($course1);
159         // Enrol the searcher and one user in the course.
160         $this->getDataGenerator()->enrol_user($user1->id, $course1->id);
161         $this->getDataGenerator()->enrol_user($user2->id, $course1->id);
163         // Perform a search.
164         $results = \core_message\api::search_users_in_course($user1->id, $course1->id, 'User');
166         $this->assertEquals(1, count($results));
168         $user = $results[0];
169         $this->assertEquals($user2->id, $user->userid);
170         $this->assertEquals(fullname($user2), $user->fullname);
171         $this->assertFalse($user->ismessaging);
172         $this->assertNull($user->lastmessage);
173         $this->assertNull($user->messageid);
174         $this->assertNull($user->isonline);
175         $this->assertFalse($user->isread);
176         $this->assertTrue($user->isblocked);
177         $this->assertNull($user->unreadcount);
178     }
180     /**
181      * Tests searching users.
182      */
183     public function test_search_users() {
184         global $DB;
186         // Create some users.
187         $user1 = new stdClass();
188         $user1->firstname = 'User';
189         $user1->lastname = 'One';
190         $user1 = self::getDataGenerator()->create_user($user1);
192         // Set as the user performing the search.
193         $this->setUser($user1);
195         $user2 = new stdClass();
196         $user2->firstname = 'User search';
197         $user2->lastname = 'Two';
198         $user2 = self::getDataGenerator()->create_user($user2);
200         $user3 = new stdClass();
201         $user3->firstname = 'User search';
202         $user3->lastname = 'Three';
203         $user3 = self::getDataGenerator()->create_user($user3);
205         $user4 = new stdClass();
206         $user4->firstname = 'User';
207         $user4->lastname = 'Four';
208         $user4 = self::getDataGenerator()->create_user($user4);
210         $user5 = new stdClass();
211         $user5->firstname = 'User search';
212         $user5->lastname = 'Five';
213         $user5 = self::getDataGenerator()->create_user($user5);
215         $user6 = new stdClass();
216         $user6->firstname = 'User';
217         $user6->lastname = 'Six';
218         $user6 = self::getDataGenerator()->create_user($user6);
220         // Create some courses.
221         $course1 = new stdClass();
222         $course1->fullname = 'Course search';
223         $course1->shortname = 'One';
224         $course1 = $this->getDataGenerator()->create_course($course1);
226         $course2 = new stdClass();
227         $course2->fullname = 'Course';
228         $course2->shortname = 'Two';
229         $course2 = $this->getDataGenerator()->create_course($course2);
231         $course3 = new stdClass();
232         $course3->fullname = 'Course';
233         $course3->shortname = 'Three search';
234         $course3 = $this->getDataGenerator()->create_course($course3);
236         $course4 = new stdClass();
237         $course4->fullname = 'Course Four';
238         $course4->shortname = 'CF100';
239         $course4 = $this->getDataGenerator()->create_course($course4);
241         $course5 = new stdClass();
242         $course5->fullname = 'Course';
243         $course5->shortname = 'Five search';
244         $course5 = $this->getDataGenerator()->create_course($course5);
246         $role = $DB->get_record('role', ['shortname' => 'student']);
247         $this->getDataGenerator()->enrol_user($user1->id, $course1->id, $role->id);
248         $this->getDataGenerator()->enrol_user($user1->id, $course2->id, $role->id);
249         $this->getDataGenerator()->enrol_user($user1->id, $course3->id, $role->id);
250         $this->getDataGenerator()->enrol_user($user1->id, $course5->id, $role->id);
252         // Add some users as contacts.
253         \core_message\api::add_contact($user1->id, $user2->id);
254         \core_message\api::add_contact($user1->id, $user3->id);
255         \core_message\api::add_contact($user1->id, $user4->id);
257         // Remove the viewparticipants capability from one of the courses.
258         $course5context = context_course::instance($course5->id);
259         assign_capability('moodle/course:viewparticipants', CAP_PROHIBIT, $role->id, $course5context->id);
261         // Perform a search $CFG->messagingallusers setting enabled.
262         set_config('messagingallusers', 1);
263         list($contacts, $courses, $noncontacts) = \core_message\api::search_users($user1->id, 'search');
265         // Check that we retrieved the correct contacts.
266         $this->assertEquals(2, count($contacts));
267         $this->assertEquals($user3->id, $contacts[0]->userid);
268         $this->assertEquals($user2->id, $contacts[1]->userid);
270         // Check that we retrieved the correct courses.
271         $this->assertEquals(2, count($courses));
272         $this->assertEquals($course3->id, $courses[0]->id);
273         $this->assertEquals($course1->id, $courses[1]->id);
275         // Check that we retrieved the correct non-contacts.
276         $this->assertEquals(1, count($noncontacts));
277         $this->assertEquals($user5->id, $noncontacts[0]->userid);
278     }
280     /**
281      * Tests searching users with empty result.
282      */
283     public function test_search_users_with_empty_result() {
285         // Create some users.
286         $user1 = new stdClass();
287         $user1->firstname = 'User';
288         $user1->lastname = 'One';
289         $user1 = self::getDataGenerator()->create_user($user1);
291         // Set as the user performing the search.
292         $this->setUser($user1);
294         $user2 = new stdClass();
295         $user2->firstname = 'User';
296         $user2->lastname = 'Two';
297         $user2 = self::getDataGenerator()->create_user($user2);
299         // Perform a search $CFG->messagingallusers setting enabled.
300         set_config('messagingallusers', 1);
301         list($contacts, $courses, $noncontacts) = \core_message\api::search_users($user1->id, 'search');
303         // Check results are empty.
304         $this->assertEquals(0, count($contacts));
305         $this->assertEquals(0, count($courses));
306         $this->assertEquals(0, count($noncontacts));
307     }
309     /**
310      * Tests searching for users when site-wide messaging is disabled.
311      *
312      * This test verifies that any contacts are returned, as well as any non-contacts whose profile we can view.
313      * If checks this by placing some users in the same course, where default caps would permit a user to view another user's
314      * profile.
315      */
316     public function test_message_search_users_messagingallusers_disabled() {
317         $this->resetAfterTest();
319         // Create some users.
320         $users = [];
321         foreach (range(1, 7) as $i) {
322             $user = new stdClass();
323             $user->firstname = ($i == 4) ? 'User' : 'User search'; // Ensure the fourth user won't match the search term.
324             $user->lastname = $i;
325             $user = $this->getDataGenerator()->create_user($user);
326             $users[$i] = $user;
327         }
329         // Enrol a few users in the same course, but leave them as non-contacts.
330         $course1 = $this->getDataGenerator()->create_course();
331         $this->setAdminUser();
332         $this->getDataGenerator()->enrol_user($users[1]->id, $course1->id);
333         $this->getDataGenerator()->enrol_user($users[6]->id, $course1->id);
334         $this->getDataGenerator()->enrol_user($users[7]->id, $course1->id);
336         // Add some other users as contacts.
337         \core_message\api::add_contact($users[1]->id, $users[2]->id);
338         \core_message\api::add_contact($users[3]->id, $users[1]->id);
339         \core_message\api::add_contact($users[1]->id, $users[4]->id);
341         // Create individual conversations between some users, one contact and one non-contact.
342         $ic1 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
343             [$users[1]->id, $users[2]->id]);
344         $ic2 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
345             [$users[6]->id, $users[1]->id]);
347         // Create a group conversation between 4 users, including a contact and a non-contact.
348         $gc1 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
349             [$users[1]->id, $users[2]->id, $users[4]->id, $users[7]->id], 'Project chat');
351         // Set as the user performing the search.
352         $this->setUser($users[1]);
354         // Perform a search with $CFG->messagingallusers disabled.
355         set_config('messagingallusers', 0);
356         $result = \core_message\api::message_search_users($users[1]->id, 'search');
358         // Confirm that we returns contacts and non-contacts.
359         $this->assertArrayHasKey(0, $result);
360         $this->assertArrayHasKey(1, $result);
361         $contacts = $result[0];
362         $noncontacts = $result[1];
364         // Check that we retrieved the correct contacts.
365         $this->assertCount(2, $contacts);
366         $this->assertEquals($users[2]->id, $contacts[0]->id);
367         $this->assertEquals($users[3]->id, $contacts[1]->id);
369         // Verify the correct conversations were returned for the contacts.
370         $this->assertCount(2, $contacts[0]->conversations);
371         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $contacts[0]->conversations[$gc1->id]->type);
372         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $contacts[0]->conversations[$ic1->id]->type);
374         $this->assertCount(0, $contacts[1]->conversations);
376         // Check that we retrieved the correct non-contacts.
377         // When site wide messaging is disabled, we expect to see only those users whose profiles we can view.
378         $this->assertCount(2, $noncontacts);
379         $this->assertEquals($users[6]->id, $noncontacts[0]->id);
380         $this->assertEquals($users[7]->id, $noncontacts[1]->id);
382         // Verify the correct conversations were returned for the non-contacts.
383         $this->assertCount(1, $noncontacts[0]->conversations);
384         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
385             $noncontacts[0]->conversations[$ic2->id]->type);
387         $this->assertCount(1, $noncontacts[1]->conversations);
388         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $noncontacts[1]->conversations[$gc1->id]->type);
389     }
391     /**
392      * Tests searching for users when site-wide messaging is enabled.
393      *
394      * This test verifies that any contacts are returned, as well as any non-contacts, regardless of whether the searching user
395      * can view their respective profile.
396      */
397     public function test_message_search_users_messagingallusers_enabled() {
398         $this->resetAfterTest();
400         // Create some users.
401         $users = [];
402         foreach (range(1, 8) as $i) {
403             $user = new stdClass();
404             $user->firstname = ($i == 4) ? 'User' : 'User search'; // Ensure the fourth user won't match the search term.
405             $user->lastname = $i;
406             $user = $this->getDataGenerator()->create_user($user);
407             $users[$i] = $user;
408         }
410         // Enrol a few users in the same course, but leave them as non-contacts.
411         $course1 = $this->getDataGenerator()->create_course();
412         $this->setAdminUser();
413         $this->getDataGenerator()->enrol_user($users[1]->id, $course1->id);
414         $this->getDataGenerator()->enrol_user($users[6]->id, $course1->id);
415         $this->getDataGenerator()->enrol_user($users[7]->id, $course1->id);
417         // Add some other users as contacts.
418         \core_message\api::add_contact($users[1]->id, $users[2]->id);
419         \core_message\api::add_contact($users[3]->id, $users[1]->id);
420         \core_message\api::add_contact($users[1]->id, $users[4]->id);
422         // Create individual conversations between some users, one contact and one non-contact.
423         $ic1 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
424             [$users[1]->id, $users[2]->id]);
425         $ic2 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
426             [$users[6]->id, $users[1]->id]);
428         // Create a group conversation between 5 users, including a contact and a non-contact, and a user NOT in a shared course.
429         $gc1 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
430             [$users[1]->id, $users[2]->id, $users[4]->id, $users[7]->id, $users[8]->id], 'Project chat');
432         // Set as the user performing the search.
433         $this->setUser($users[1]);
435         // Perform a search with $CFG->messagingallusers enabled.
436         set_config('messagingallusers', 1);
437         $result = \core_message\api::message_search_users($users[1]->id, 'search');
439         // Confirm that we returns contacts and non-contacts.
440         $this->assertArrayHasKey(0, $result);
441         $this->assertArrayHasKey(1, $result);
442         $contacts = $result[0];
443         $noncontacts = $result[1];
445         // Check that we retrieved the correct contacts.
446         $this->assertCount(2, $contacts);
447         $this->assertEquals($users[2]->id, $contacts[0]->id);
448         $this->assertEquals($users[3]->id, $contacts[1]->id);
450         // Verify the correct conversations were returned for the contacts.
451         $this->assertCount(2, $contacts[0]->conversations);
452         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $contacts[0]->conversations[$gc1->id]->type);
453         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $contacts[0]->conversations[$ic1->id]->type);
455         $this->assertCount(0, $contacts[1]->conversations);
457         // Check that we retrieved the correct non-contacts.
458         // If site wide messaging is enabled, we expect to be able to search for any users.
459         $this->assertCount(4, $noncontacts);
460         $this->assertEquals($users[5]->id, $noncontacts[0]->id);
461         $this->assertEquals($users[6]->id, $noncontacts[1]->id);
462         $this->assertEquals($users[7]->id, $noncontacts[2]->id);
463         $this->assertEquals($users[8]->id, $noncontacts[3]->id);
465         // Verify the correct conversations were returned for the non-contacts.
466         $this->assertCount(0, $noncontacts[0]->conversations);
468         $this->assertCount(1, $noncontacts[1]->conversations);
469         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
470             $noncontacts[1]->conversations[$ic2->id]->type);
472         $this->assertCount(1, $noncontacts[2]->conversations);
473         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $noncontacts[2]->conversations[$gc1->id]->type);
475         $this->assertCount(1, $noncontacts[3]->conversations);
476         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $noncontacts[3]->conversations[$gc1->id]->type);
477     }
479     /**
480      * Verify searching for users works even if no matching users from either contacts, or non-contacts can be found.
481      */
482     public function test_message_search_users_with_empty_result() {
483         $this->resetAfterTest();
485         // Create some users, but make sure neither will match the search term.
486         $user1 = new stdClass();
487         $user1->firstname = 'User';
488         $user1->lastname = 'One';
489         $user1 = $this->getDataGenerator()->create_user($user1);
490         $user2 = new stdClass();
491         $user2->firstname = 'User';
492         $user2->lastname = 'Two';
493         $user2 = $this->getDataGenerator()->create_user($user2);
495         // Perform a search as user1.
496         $this->setUser($user1);
497         $result = \core_message\api::message_search_users($user1->id, 'search');
499         // Check results are empty.
500         $this->assertCount(0, $result[0]);
501         $this->assertCount(0, $result[1]);
502     }
504     /**
505      * Test verifying that limits and offsets work for both the contacts and non-contacts return data.
506      */
507     public function test_message_search_users_limit_offset() {
508         $this->resetAfterTest();
510         // Create 20 users.
511         $users = [];
512         foreach (range(1, 20) as $i) {
513             $user = new stdClass();
514             $user->firstname = "User search";
515             $user->lastname = $i;
516             $user = $this->getDataGenerator()->create_user($user);
517             $users[$i] = $user;
518         }
520         // Enrol the first 9 users in the same course, but leave them as non-contacts.
521         $this->setAdminUser();
522         $course1 = $this->getDataGenerator()->create_course();
523         foreach (range(1, 9) as $i) {
524             $this->getDataGenerator()->enrol_user($users[$i]->id, $course1->id);
525         }
527         // Add 5 users, starting at the 11th user, as contacts for user1.
528         foreach (range(11, 15) as $i) {
529             \core_message\api::add_contact($users[1]->id, $users[$i]->id);
530         }
532         // Set as the user performing the search.
533         $this->setUser($users[1]);
535         // Search using a limit of 3.
536         // This tests the case where we have more results than the limit for both contacts and non-contacts.
537         $result = \core_message\api::message_search_users($users[1]->id, 'search', 0, 3);
538         $contacts = $result[0];
539         $noncontacts = $result[1];
541         // Check that we retrieved the correct contacts.
542         $this->assertCount(3, $contacts);
543         $this->assertEquals($users[11]->id, $contacts[0]->id);
544         $this->assertEquals($users[12]->id, $contacts[1]->id);
545         $this->assertEquals($users[13]->id, $contacts[2]->id);
547         // Check that we retrieved the correct non-contacts.
548         $this->assertCount(3, $noncontacts);
549         $this->assertEquals($users[2]->id, $noncontacts[0]->id);
550         $this->assertEquals($users[3]->id, $noncontacts[1]->id);
551         $this->assertEquals($users[4]->id, $noncontacts[2]->id);
553         // Now, offset to get the next batch of results.
554         // We expect to see 2 contacts, and 3 non-contacts.
555         $result = \core_message\api::message_search_users($users[1]->id, 'search', 3, 3);
556         $contacts = $result[0];
557         $noncontacts = $result[1];
558         $this->assertCount(2, $contacts);
559         $this->assertEquals($users[14]->id, $contacts[0]->id);
560         $this->assertEquals($users[15]->id, $contacts[1]->id);
562         $this->assertCount(3, $noncontacts);
563         $this->assertEquals($users[5]->id, $noncontacts[0]->id);
564         $this->assertEquals($users[6]->id, $noncontacts[1]->id);
565         $this->assertEquals($users[7]->id, $noncontacts[2]->id);
567         // Now, offset to get the next batch of results.
568         // We expect to see 0 contacts, and 2 non-contacts.
569         $result = \core_message\api::message_search_users($users[1]->id, 'search', 6, 3);
570         $contacts = $result[0];
571         $noncontacts = $result[1];
572         $this->assertCount(0, $contacts);
574         $this->assertCount(2, $noncontacts);
575         $this->assertEquals($users[8]->id, $noncontacts[0]->id);
576         $this->assertEquals($users[9]->id, $noncontacts[1]->id);
577     }
579     /**
580      * Tests searching users as a user having the 'moodle/user:viewdetails' capability.
581      */
582     public function test_message_search_users_with_cap() {
583         $this->resetAfterTest();
584         global $DB;
586         // Create some users.
587         $users = [];
588         foreach (range(1, 8) as $i) {
589             $user = new stdClass();
590             $user->firstname = ($i == 4) ? 'User' : 'User search'; // Ensure the fourth user won't match the search term.
591             $user->lastname = $i;
592             $user = $this->getDataGenerator()->create_user($user);
593             $users[$i] = $user;
594         }
596         // Enrol a few users in the same course, but leave them as non-contacts.
597         $course1 = $this->getDataGenerator()->create_course();
598         $this->setAdminUser();
599         $this->getDataGenerator()->enrol_user($users[1]->id, $course1->id);
600         $this->getDataGenerator()->enrol_user($users[6]->id, $course1->id);
601         $this->getDataGenerator()->enrol_user($users[7]->id, $course1->id);
603         // Add some other users as contacts.
604         \core_message\api::add_contact($users[1]->id, $users[2]->id);
605         \core_message\api::add_contact($users[3]->id, $users[1]->id);
606         \core_message\api::add_contact($users[1]->id, $users[4]->id);
608         // Set as the user performing the search.
609         $this->setUser($users[1]);
611         // Grant the authenticated user role the capability 'user:viewdetails' at site context.
612         $authenticatedrole = $DB->get_record('role', ['shortname' => 'user'], '*', MUST_EXIST);
613         assign_capability('moodle/user:viewdetails', CAP_ALLOW, $authenticatedrole->id, context_system::instance());
615         // Perform a search with $CFG->messagingallusers disabled.
616         set_config('messagingallusers', 0);
617         $result = \core_message\api::message_search_users($users[1]->id, 'search');
618         $contacts = $result[0];
619         $noncontacts = $result[1];
621         // Check that we retrieved the correct contacts.
622         $this->assertCount(2, $contacts);
623         $this->assertEquals($users[2]->id, $contacts[0]->id);
624         $this->assertEquals($users[3]->id, $contacts[1]->id);
626         // Check that we retrieved the correct non-contacts.
627         // Site-wide messaging is disabled, but since we can see all users, we expect to be able to search for any users.
628         $this->assertCount(4, $noncontacts);
629         $this->assertEquals($users[5]->id, $noncontacts[0]->id);
630         $this->assertEquals($users[6]->id, $noncontacts[1]->id);
631         $this->assertEquals($users[7]->id, $noncontacts[2]->id);
632         $this->assertEquals($users[8]->id, $noncontacts[3]->id);
633     }
635     /**
636      * Tests searching users with messaging disabled.
637      */
638     public function test_message_search_users_messaging_disabled() {
639         $this->resetAfterTest();
641         // Create a user.
642         $user = $this->getDataGenerator()->create_user();
644         // Disable messaging.
645         set_config('messaging', 0);
647         // Ensure an exception is thrown.
648         $this->expectException('moodle_exception');
649         \core_message\api::message_search_users($user->id, 'User');
650     }
652     /**
653      * Tests getting conversations between 2 users.
654      */
655     public function test_get_conversations_between_users() {
656         // Create some users.
657         $user1 = new stdClass();
658         $user1->firstname = 'User';
659         $user1->lastname = 'One';
660         $user1 = self::getDataGenerator()->create_user($user1);
662         $user2 = new stdClass();
663         $user2->firstname = 'User';
664         $user2->lastname = 'Two';
665         $user2 = self::getDataGenerator()->create_user($user2);
667         $user3 = new stdClass();
668         $user3->firstname = 'User search';
669         $user3->lastname = 'Three';
670         $user3 = self::getDataGenerator()->create_user($user3);
672         $user4 = new stdClass();
673         $user4->firstname = 'User';
674         $user4->lastname = 'Four';
675         $user4 = self::getDataGenerator()->create_user($user4);
677         $user5 = new stdClass();
678         $user5->firstname = 'User';
679         $user5->lastname = 'Five';
680         $user5 = self::getDataGenerator()->create_user($user5);
682         $user6 = new stdClass();
683         $user6->firstname = 'User search';
684         $user6->lastname = 'Six';
685         $user6 = self::getDataGenerator()->create_user($user6);
687         // Add some users as contacts.
688         \core_message\api::add_contact($user1->id, $user2->id);
689         \core_message\api::add_contact($user6->id, $user1->id);
691         // Create private conversations with some users.
692         \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
693             array($user1->id, $user2->id));
694         \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
695             array($user3->id, $user1->id));
697         // Create a group conversation with users.
698         \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
699             array($user1->id, $user2->id, $user3->id, $user4->id),
700             'Project chat');
702         // Check that we retrieved the correct conversations.
703         $this->assertCount(2, \core_message\api::get_conversations_between_users($user1->id, $user2->id));
704         $this->assertCount(2, \core_message\api::get_conversations_between_users($user2->id, $user1->id));
705         $this->assertCount(2, \core_message\api::get_conversations_between_users($user1->id, $user3->id));
706         $this->assertCount(2, \core_message\api::get_conversations_between_users($user3->id, $user1->id));
707         $this->assertCount(1, \core_message\api::get_conversations_between_users($user1->id, $user4->id));
708         $this->assertCount(1, \core_message\api::get_conversations_between_users($user4->id, $user1->id));
709         $this->assertCount(0, \core_message\api::get_conversations_between_users($user1->id, $user5->id));
710         $this->assertCount(0, \core_message\api::get_conversations_between_users($user5->id, $user1->id));
711         $this->assertCount(0, \core_message\api::get_conversations_between_users($user1->id, $user6->id));
712         $this->assertCount(0, \core_message\api::get_conversations_between_users($user6->id, $user1->id));
713     }
715     /**
716      * Tests searching messages.
717      */
718     public function test_search_messages() {
719         // Create some users.
720         $user1 = self::getDataGenerator()->create_user();
721         $user2 = self::getDataGenerator()->create_user();
722         $user3 = self::getDataGenerator()->create_user();
724         // The person doing the search.
725         $this->setUser($user1);
727         // Send some messages back and forth.
728         $time = 1;
729         $this->send_fake_message($user3, $user1, 'Don\'t block me.', 0, $time);
730         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
731         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
732         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
733         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
735         $convid = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
736         $conv2id = \core_message\api::get_conversation_between_users([$user1->id, $user3->id]);
738         // Block user 3.
739         \core_message\api::block_user($user1->id, $user3->id);
741         // Perform a search.
742         $messages = \core_message\api::search_messages($user1->id, 'o');
744         // Confirm the data is correct.
745         $this->assertEquals(3, count($messages));
747         $message1 = $messages[0];
748         $message2 = $messages[1];
749         $message3 = $messages[2];
751         $this->assertEquals($user2->id, $message1->userid);
752         $this->assertEquals($user2->id, $message1->useridfrom);
753         $this->assertEquals(fullname($user2), $message1->fullname);
754         $this->assertTrue($message1->ismessaging);
755         $this->assertEquals('Word.', $message1->lastmessage);
756         $this->assertNotEmpty($message1->messageid);
757         $this->assertNull($message1->isonline);
758         $this->assertFalse($message1->isread);
759         $this->assertFalse($message1->isblocked);
760         $this->assertNull($message1->unreadcount);
761         $this->assertEquals($convid, $message1->conversationid);
763         $this->assertEquals($user2->id, $message2->userid);
764         $this->assertEquals($user1->id, $message2->useridfrom);
765         $this->assertEquals(fullname($user2), $message2->fullname);
766         $this->assertTrue($message2->ismessaging);
767         $this->assertEquals('Yo!', $message2->lastmessage);
768         $this->assertNotEmpty($message2->messageid);
769         $this->assertNull($message2->isonline);
770         $this->assertTrue($message2->isread);
771         $this->assertFalse($message2->isblocked);
772         $this->assertNull($message2->unreadcount);
773         $this->assertEquals($convid, $message2->conversationid);
775         $this->assertEquals($user3->id, $message3->userid);
776         $this->assertEquals($user3->id, $message3->useridfrom);
777         $this->assertEquals(fullname($user3), $message3->fullname);
778         $this->assertTrue($message3->ismessaging);
779         $this->assertEquals('Don\'t block me.', $message3->lastmessage);
780         $this->assertNotEmpty($message3->messageid);
781         $this->assertNull($message3->isonline);
782         $this->assertFalse($message3->isread);
783         $this->assertTrue($message3->isblocked);
784         $this->assertNull($message3->unreadcount);
785         $this->assertEquals($conv2id, $message3->conversationid);
786     }
788     /**
789      * Test verifying that favourited conversations can be retrieved.
790      */
791     public function test_get_favourite_conversations() {
792         // Create some users.
793         $user1 = self::getDataGenerator()->create_user();
794         $user2 = self::getDataGenerator()->create_user();
795         $user3 = self::getDataGenerator()->create_user();
796         $user4 = self::getDataGenerator()->create_user();
798         // The person doing the search.
799         $this->setUser($user1);
801         // No conversations yet.
802         $this->assertEquals([], \core_message\api::get_conversations($user1->id));
804         // Create some conversations for user1.
805         $time = 1;
806         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
807         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
808         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
809         $messageid1 = $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
811         $this->send_fake_message($user1, $user3, 'Booyah', 0, $time + 5);
812         $this->send_fake_message($user3, $user1, 'Whaaat?', 0, $time + 6);
813         $this->send_fake_message($user1, $user3, 'Nothing.', 0, $time + 7);
814         $messageid2 = $this->send_fake_message($user3, $user1, 'Cool.', 0, $time + 8);
816         $this->send_fake_message($user1, $user4, 'Hey mate, you see the new messaging UI in Moodle?', 0, $time + 9);
817         $this->send_fake_message($user4, $user1, 'Yah brah, it\'s pretty rad.', 0, $time + 10);
818         $messageid3 = $this->send_fake_message($user1, $user4, 'Dope.', 0, $time + 11);
820         // Favourite the first 2 conversations for user1.
821         $convoids = [];
822         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
823         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user3->id]);
824         $user1context = context_user::instance($user1->id);
825         $service = \core_favourites\service_factory::get_service_for_user_context($user1context);
826         foreach ($convoids as $convoid) {
827             $service->create_favourite('core_message', 'message_conversations', $convoid, $user1context);
828         }
830         // We should have 3 conversations.
831         $this->assertCount(3, \core_message\api::get_conversations($user1->id));
833         // And 2 favourited conversations.
834         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, null, true);
835         $this->assertCount(2, $conversations);
836     }
838     /**
839      * Tests retrieving favourite conversations with a limit and offset to ensure pagination works correctly.
840      */
841     public function test_get_favourite_conversations_limit_offset() {
842         // Create some users.
843         $user1 = self::getDataGenerator()->create_user();
844         $user2 = self::getDataGenerator()->create_user();
845         $user3 = self::getDataGenerator()->create_user();
846         $user4 = self::getDataGenerator()->create_user();
848         // The person doing the search.
849         $this->setUser($user1);
851         // No conversations yet.
852         $this->assertEquals([], \core_message\api::get_conversations($user1->id));
854         // Create some conversations for user1.
855         $time = 1;
856         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
857         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
858         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
859         $messageid1 = $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
861         $this->send_fake_message($user1, $user3, 'Booyah', 0, $time + 5);
862         $this->send_fake_message($user3, $user1, 'Whaaat?', 0, $time + 6);
863         $this->send_fake_message($user1, $user3, 'Nothing.', 0, $time + 7);
864         $messageid2 = $this->send_fake_message($user3, $user1, 'Cool.', 0, $time + 8);
866         $this->send_fake_message($user1, $user4, 'Hey mate, you see the new messaging UI in Moodle?', 0, $time + 9);
867         $this->send_fake_message($user4, $user1, 'Yah brah, it\'s pretty rad.', 0, $time + 10);
868         $messageid3 = $this->send_fake_message($user1, $user4, 'Dope.', 0, $time + 11);
870         // Favourite the all conversations for user1.
871         $convoids = [];
872         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
873         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user3->id]);
874         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user4->id]);
875         $user1context = context_user::instance($user1->id);
876         $service = \core_favourites\service_factory::get_service_for_user_context($user1context);
877         foreach ($convoids as $convoid) {
878             $service->create_favourite('core_message', 'message_conversations', $convoid, $user1context);
879         }
881         // Get all records, using offset 0 and large limit.
882         $this->assertCount(2, \core_message\api::get_conversations($user1->id, 1, 10, null, true));
884         // Now, get 10 conversations starting at the second record. We should see 2 conversations.
885         $this->assertCount(2, \core_message\api::get_conversations($user1->id, 1, 10, null, true));
887         // Now, try to get favourited conversations using an invalid offset.
888         $this->assertCount(0, \core_message\api::get_conversations($user1->id, 4, 10, null, true));
889     }
891     /**
892      * Tests retrieving favourite conversations when a conversation contains a deleted user.
893      */
894     public function test_get_favourite_conversations_with_deleted_user() {
895         // Create some users.
896         $user1 = self::getDataGenerator()->create_user();
897         $user2 = self::getDataGenerator()->create_user();
898         $user3 = self::getDataGenerator()->create_user();
900         // Send some messages back and forth, have some different conversations with different users.
901         $time = 1;
902         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
903         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
904         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
905         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
907         $this->send_fake_message($user1, $user3, 'Booyah', 0, $time + 5);
908         $this->send_fake_message($user3, $user1, 'Whaaat?', 0, $time + 6);
909         $this->send_fake_message($user1, $user3, 'Nothing.', 0, $time + 7);
910         $this->send_fake_message($user3, $user1, 'Cool.', 0, $time + 8);
912         // Favourite the all conversations for user1.
913         $convoids = [];
914         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
915         $convoids[] = \core_message\api::get_conversation_between_users([$user1->id, $user3->id]);
916         $user1context = context_user::instance($user1->id);
917         $service = \core_favourites\service_factory::get_service_for_user_context($user1context);
918         foreach ($convoids as $convoid) {
919             $service->create_favourite('core_message', 'message_conversations', $convoid, $user1context);
920         }
922         // Delete the second user.
923         delete_user($user2);
925         // Retrieve the conversations.
926         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, null, true);
928         // We should have both conversations, despite the other user being soft-deleted.
929         $this->assertCount(2, $conversations);
931         // Confirm the conversation is from the non-deleted user.
932         $conversation = reset($conversations);
933         $this->assertEquals($convoids[1], $conversation->id);
934     }
936     /**
937      * Test confirming that conversations can be marked as favourites.
938      */
939     public function test_set_favourite_conversation() {
940         // Create some users.
941         $user1 = self::getDataGenerator()->create_user();
942         $user2 = self::getDataGenerator()->create_user();
943         $user3 = self::getDataGenerator()->create_user();
945         // Send some messages back and forth, have some different conversations with different users.
946         $time = 1;
947         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
948         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
949         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
950         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
952         $this->send_fake_message($user1, $user3, 'Booyah', 0, $time + 5);
953         $this->send_fake_message($user3, $user1, 'Whaaat?', 0, $time + 6);
954         $this->send_fake_message($user1, $user3, 'Nothing.', 0, $time + 7);
955         $this->send_fake_message($user3, $user1, 'Cool.', 0, $time + 8);
957         // Favourite the first conversation as user 1.
958         $conversationid1 = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
959         $favourite = \core_message\api::set_favourite_conversation($conversationid1, $user1->id);
961         // Verify we have a single favourite conversation a user 1.
962         $this->assertCount(1, \core_message\api::get_conversations($user1->id, 0, 20, null, true));
964         // Verify we have no favourites as user2, despite being a member in that conversation.
965         $this->assertCount(0, \core_message\api::get_conversations($user2->id, 0, 20, null, true));
967         // Try to favourite the same conversation again should just return the existing favourite.
968         $repeatresult = \core_message\api::set_favourite_conversation($conversationid1, $user1->id);
969         $this->assertEquals($favourite->id, $repeatresult->id);
970     }
972     /**
973      * Test verifying that trying to mark a non-existent conversation as a favourite, results in an exception.
974      */
975     public function test_set_favourite_conversation_nonexistent_conversation() {
976         // Create some users.
977         $user1 = self::getDataGenerator()->create_user();
978         // Try to favourite a non-existent conversation.
979         $this->expectException(\moodle_exception::class);
980         \core_message\api::set_favourite_conversation(0, $user1->id);
981     }
983     /**
984      * Test verifying that a conversation cannot be marked as favourite unless the user is a member of that conversation.
985      */
986     public function test_set_favourite_conversation_non_member() {
987         // Create some users.
988         $user1 = self::getDataGenerator()->create_user();
989         $user2 = self::getDataGenerator()->create_user();
990         $user3 = self::getDataGenerator()->create_user();
992         // Send some messages back and forth, have some different conversations with different users.
993         $time = 1;
994         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
995         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
996         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
997         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
999         $this->send_fake_message($user1, $user3, 'Booyah', 0, $time + 5);
1000         $this->send_fake_message($user3, $user1, 'Whaaat?', 0, $time + 6);
1001         $this->send_fake_message($user1, $user3, 'Nothing.', 0, $time + 7);
1002         $this->send_fake_message($user3, $user1, 'Cool.', 0, $time + 8);
1004         // Try to favourite the first conversation as user 3, who is not a member.
1005         $conversationid1 = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
1006         $this->expectException(\moodle_exception::class);
1007         \core_message\api::set_favourite_conversation($conversationid1, $user3->id);
1008     }
1010     /**
1011      * Test confirming that those conversations marked as favourites can be unfavourited.
1012      */
1013     public function test_unset_favourite_conversation() {
1014         // Create some users.
1015         $user1 = self::getDataGenerator()->create_user();
1016         $user2 = self::getDataGenerator()->create_user();
1017         $user3 = self::getDataGenerator()->create_user();
1019         // Send some messages back and forth, have some different conversations with different users.
1020         $time = 1;
1021         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
1022         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
1023         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
1024         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
1026         $this->send_fake_message($user1, $user3, 'Booyah', 0, $time + 5);
1027         $this->send_fake_message($user3, $user1, 'Whaaat?', 0, $time + 6);
1028         $this->send_fake_message($user1, $user3, 'Nothing.', 0, $time + 7);
1029         $this->send_fake_message($user3, $user1, 'Cool.', 0, $time + 8);
1031         // Favourite the first conversation as user 1 and the second as user 3.
1032         $conversationid1 = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
1033         $conversationid2 = \core_message\api::get_conversation_between_users([$user1->id, $user3->id]);
1034         \core_message\api::set_favourite_conversation($conversationid1, $user1->id);
1035         \core_message\api::set_favourite_conversation($conversationid2, $user3->id);
1037         // Verify we have a single favourite conversation for both user 1 and user 3.
1038         $this->assertCount(1, \core_message\api::get_conversations($user1->id, 0, 20, null, true));
1039         $this->assertCount(1, \core_message\api::get_conversations($user3->id, 0, 20, null, true));
1041         // Now unfavourite the conversation as user 1.
1042         \core_message\api::unset_favourite_conversation($conversationid1, $user1->id);
1044         // Verify we have a single favourite conversation user 3 only, and none for user1.
1045         $this->assertCount(1, \core_message\api::get_conversations($user3->id, 0, 20, null, true));
1046         $this->assertCount(0, \core_message\api::get_conversations($user1->id, 0, 20, null, true));
1048         // Try to favourite the same conversation again as user 1.
1049         $this->expectException(\moodle_exception::class);
1050         \core_message\api::unset_favourite_conversation($conversationid1, $user1->id);
1051     }
1053     /**
1054      * Test verifying that a valid conversation cannot be unset as a favourite if it's not marked as a favourite.
1055      */
1056     public function test_unset_favourite_conversation_not_favourite() {
1057         // Create some users.
1058         $user1 = self::getDataGenerator()->create_user();
1059         $user2 = self::getDataGenerator()->create_user();
1061         // Send some messages back and forth, have some different conversations with different users.
1062         $time = 1;
1063         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
1064         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
1065         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
1066         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
1068         // Now try to unfavourite the conversation as user 1.
1069         $conversationid1 = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
1070         $this->expectException(\moodle_exception::class);
1071         \core_message\api::unset_favourite_conversation($conversationid1, $user1->id);
1072     }
1074     /**
1075      * Test verifying that a non-existent conversation cannot be unset as a favourite.
1076      */
1077     public function test_unset_favourite_conversation_non_existent_conversation() {
1078         // Create some users.
1079         $user1 = self::getDataGenerator()->create_user();
1081         // Now try to unfavourite the conversation as user 1.
1082         $this->expectException(\moodle_exception::class);
1083         \core_message\api::unset_favourite_conversation(0, $user1->id);
1084     }
1086     /**
1087      * Helper to seed the database with initial state.
1088      */
1089     protected function create_conversation_test_data() {
1090         // Create some users.
1091         $user1 = self::getDataGenerator()->create_user();
1092         $user2 = self::getDataGenerator()->create_user();
1093         $user3 = self::getDataGenerator()->create_user();
1094         $user4 = self::getDataGenerator()->create_user();
1096         $time = 1;
1098         // Create some conversations. We want:
1099         // 1) At least one of each type (group, individual) of which user1 IS a member and DID send the most recent message.
1100         // 2) At least one of each type (group, individual) of which user1 IS a member and DID NOT send the most recent message.
1101         // 3) At least one of each type (group, individual) of which user1 IS NOT a member.
1102         // 4) At least two group conversation having 0 messages, of which user1 IS a member (To confirm conversationid ordering).
1103         // 5) At least one group conversation having 0 messages, of which user1 IS NOT a member.
1105         // Individual conversation, user1 is a member, last message from other user.
1106         $ic1 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1107             [$user1->id, $user2->id]);
1108         testhelper::send_fake_message_to_conversation($user1, $ic1->id, 'Message 1', $time);
1109         testhelper::send_fake_message_to_conversation($user2, $ic1->id, 'Message 2', $time + 1);
1111         // Individual conversation, user1 is a member, last message from user1.
1112         $ic2 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1113             [$user1->id, $user3->id]);
1114         testhelper::send_fake_message_to_conversation($user3, $ic2->id, 'Message 3', $time + 2);
1115         testhelper::send_fake_message_to_conversation($user1, $ic2->id, 'Message 4', $time + 3);
1117         // Individual conversation, user1 is not a member.
1118         $ic3 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1119             [$user2->id, $user3->id]);
1120         testhelper::send_fake_message_to_conversation($user2, $ic3->id, 'Message 5', $time + 4);
1121         testhelper::send_fake_message_to_conversation($user3, $ic3->id, 'Message 6', $time + 5);
1123         // Group conversation, user1 is not a member.
1124         $gc1 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1125             [$user2->id, $user3->id, $user4->id], 'Project discussions');
1126         testhelper::send_fake_message_to_conversation($user2, $gc1->id, 'Message 7', $time + 6);
1127         testhelper::send_fake_message_to_conversation($user4, $gc1->id, 'Message 8', $time + 7);
1129         // Group conversation, user1 is a member, last message from another user.
1130         $gc2 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1131             [$user1->id, $user3->id, $user4->id], 'Group chat');
1132         testhelper::send_fake_message_to_conversation($user1, $gc2->id, 'Message 9', $time + 8);
1133         testhelper::send_fake_message_to_conversation($user3, $gc2->id, 'Message 10', $time + 9);
1134         testhelper::send_fake_message_to_conversation($user4, $gc2->id, 'Message 11', $time + 10);
1136         // Group conversation, user1 is a member, last message from user1.
1137         $gc3 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1138             [$user1->id, $user2->id, $user3->id, $user4->id], 'Group chat again!');
1139         testhelper::send_fake_message_to_conversation($user4, $gc3->id, 'Message 12', $time + 11);
1140         testhelper::send_fake_message_to_conversation($user3, $gc3->id, 'Message 13', $time + 12);
1141         testhelper::send_fake_message_to_conversation($user1, $gc3->id, 'Message 14', $time + 13);
1143         // Empty group conversations (x2), user1 is a member.
1144         $gc4 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1145             [$user1->id, $user2->id, $user3->id], 'Empty group');
1146         $gc5 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1147             [$user1->id, $user2->id, $user4->id], 'Another empty group');
1149         // Empty group conversation, user1 is NOT a member.
1150         $gc6 = \core_message\api::create_conversation(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1151             [$user2->id, $user3->id, $user4->id], 'Empty group 3');
1153         return [$user1, $user2, $user3, $user4, $ic1, $ic2, $ic3, $gc1, $gc2, $gc3, $gc4, $gc5, $gc6];
1154     }
1156     /**
1157      * Test verifying get_conversations when no limits, offsets, type filters or favourite restrictions are used.
1158      */
1159     public function test_get_conversations_no_restrictions() {
1160         global $DB;
1161         // No conversations should exist yet.
1162         $user1 = self::getDataGenerator()->create_user();
1163         $this->assertEquals([], \core_message\api::get_conversations($user1->id));
1165         // Get a bunch of conversations, some group, some individual and in different states.
1166         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1167             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1169         // Get all conversations for user1.
1170         $conversations = core_message\api::get_conversations($user1->id);
1172         // Verify there are 2 individual conversation, 2 group conversations, and 2 empty group conversations.
1173         // The conversations with the most recent messages should be listed first, followed by the empty
1174         // conversations, with the most recently created first.
1175         $this->assertCount(6, $conversations);
1176         $typecounts  = array_count_values(array_column($conversations, 'type'));
1177         $this->assertEquals(2, $typecounts[1]);
1178         $this->assertEquals(4, $typecounts[2]);
1180         // Those conversations having messages should be listed first, ordered by most recent message time.
1181         $this->assertEquals($gc3->id, $conversations[0]->id);
1182         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $conversations[0]->type);
1183         $this->assertFalse($conversations[0]->isfavourite);
1184         $this->assertCount(1, $conversations[0]->members);
1185         $this->assertEquals(4, $conversations[0]->membercount);
1186         $this->assertCount(1, $conversations[0]->messages);
1187         $message = $DB->get_record('messages', ['id' => $conversations[0]->messages[0]->id]);
1188         $expectedmessagetext = message_format_message_text($message);
1189         $this->assertEquals($expectedmessagetext, $conversations[0]->messages[0]->text);
1190         $this->assertEquals($user1->id, $conversations[0]->messages[0]->useridfrom);
1192         $this->assertEquals($gc2->id, $conversations[1]->id);
1193         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $conversations[1]->type);
1194         $this->assertFalse($conversations[1]->isfavourite);
1195         $this->assertCount(1, $conversations[1]->members);
1196         $this->assertEquals(3, $conversations[1]->membercount);
1197         $this->assertCount(1, $conversations[1]->messages);
1198         $message = $DB->get_record('messages', ['id' => $conversations[1]->messages[0]->id]);
1199         $expectedmessagetext = message_format_message_text($message);
1200         $this->assertEquals($expectedmessagetext, $conversations[1]->messages[0]->text);
1201         $this->assertEquals($user4->id, $conversations[1]->messages[0]->useridfrom);
1203         $this->assertEquals($ic2->id, $conversations[2]->id);
1204         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $conversations[2]->type);
1205         $this->assertFalse($conversations[2]->isfavourite);
1206         $this->assertCount(1, $conversations[2]->members);
1207         $this->assertEquals($user3->id, $conversations[2]->members[$user3->id]->id);
1208         $this->assertEquals(2, $conversations[2]->membercount);
1209         $this->assertCount(1, $conversations[2]->messages);
1210         $message = $DB->get_record('messages', ['id' => $conversations[2]->messages[0]->id]);
1211         $expectedmessagetext = message_format_message_text($message);
1212         $this->assertEquals($expectedmessagetext, $conversations[2]->messages[0]->text);
1213         $this->assertEquals($user1->id, $conversations[2]->messages[0]->useridfrom);
1215         $this->assertEquals($ic1->id, $conversations[3]->id);
1216         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $conversations[3]->type);
1217         $this->assertFalse($conversations[3]->isfavourite);
1218         $this->assertCount(1, $conversations[3]->members);
1219         $this->assertEquals(2, $conversations[3]->membercount);
1220         $this->assertCount(1, $conversations[3]->messages);
1221         $message = $DB->get_record('messages', ['id' => $conversations[3]->messages[0]->id]);
1222         $expectedmessagetext = message_format_message_text($message);
1223         $this->assertEquals($expectedmessagetext, $conversations[3]->messages[0]->text);
1224         $this->assertEquals($user2->id, $conversations[3]->messages[0]->useridfrom);
1226         // Of the groups without messages, we expect to see the most recently created first.
1227         $this->assertEquals($gc5->id, $conversations[4]->id);
1228         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $conversations[4]->type);
1229         $this->assertFalse($conversations[4]->isfavourite);
1230         $this->assertCount(0, $conversations[4]->members); // No members returned, because no recent messages exist.
1231         $this->assertEquals(3, $conversations[4]->membercount);
1232         $this->assertEmpty($conversations[4]->messages);
1234         $this->assertEquals($gc4->id, $conversations[5]->id);
1235         $this->assertEquals(\core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, $conversations[5]->type);
1236         $this->assertFalse($conversations[5]->isfavourite);
1237         $this->assertCount(0, $conversations[5]->members);
1238         $this->assertEquals(3, $conversations[5]->membercount);
1239         $this->assertEmpty($conversations[5]->messages);
1241         // Verify format of the return structure.
1242         foreach ($conversations as $conv) {
1243             $this->assertObjectHasAttribute('id', $conv);
1244             $this->assertObjectHasAttribute('name', $conv);
1245             $this->assertObjectHasAttribute('subname', $conv);
1246             $this->assertObjectHasAttribute('imageurl', $conv);
1247             $this->assertObjectHasAttribute('type', $conv);
1248             $this->assertObjectHasAttribute('isfavourite', $conv);
1249             $this->assertObjectHasAttribute('membercount', $conv);
1250             $this->assertObjectHasAttribute('isread', $conv);
1251             $this->assertObjectHasAttribute('unreadcount', $conv);
1252             $this->assertObjectHasAttribute('members', $conv);
1253             foreach ($conv->members as $member) {
1254                 $this->assertObjectHasAttribute('id', $member);
1255                 $this->assertObjectHasAttribute('fullname', $member);
1256                 $this->assertObjectHasAttribute('profileimageurl', $member);
1257                 $this->assertObjectHasAttribute('profileimageurlsmall', $member);
1258                 $this->assertObjectHasAttribute('isonline', $member);
1259                 $this->assertObjectHasAttribute('showonlinestatus', $member);
1260                 $this->assertObjectHasAttribute('isblocked', $member);
1261                 $this->assertObjectHasAttribute('iscontact', $member);
1262                 $this->assertObjectHasAttribute('isdeleted', $member);
1263                 $this->assertObjectHasAttribute('canmessage', $member);
1264                 $this->assertObjectHasAttribute('requirescontact', $member);
1265                 $this->assertObjectHasAttribute('contactrequests', $member);
1266             }
1267             $this->assertObjectHasAttribute('messages', $conv);
1268             foreach ($conv->messages as $message) {
1269                 $this->assertObjectHasAttribute('id', $message);
1270                 $this->assertObjectHasAttribute('useridfrom', $message);
1271                 $this->assertObjectHasAttribute('text', $message);
1272                 $this->assertObjectHasAttribute('timecreated', $message);
1273             }
1274         }
1275     }
1277     /**
1278      * Test verifying that html format messages are supported, and that message_format_message_text() is being called appropriately.
1279      */
1280     public function test_get_conversations_message_format() {
1281         global $DB;
1282         // Create some users.
1283         $user1 = self::getDataGenerator()->create_user();
1284         $user2 = self::getDataGenerator()->create_user();
1286         // Create conversation.
1287         $conversation = \core_message\api::create_conversation(
1288             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1289             [$user1->id, $user2->id]
1290         );
1292         // Send some messages back and forth.
1293         $time = 1;
1294         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Sup mang?', $time + 1);
1295         $mid = testhelper::send_fake_message_to_conversation($user1, $conversation->id, '<a href="#">A link</a>', $time + 2);
1297         // Verify the format of the html message.
1298         $message = $DB->get_record('messages', ['id' => $mid]);
1299         $expectedmessagetext = message_format_message_text($message);
1300         $conversations = \core_message\api::get_conversations($user1->id);
1301         $messages = $conversations[0]->messages;
1302         $this->assertEquals($expectedmessagetext, $messages[0]->text);
1303     }
1305     /**
1306      * Tests retrieving conversations with a limit and offset to ensure pagination works correctly.
1307      */
1308     public function test_get_conversations_limit_offset() {
1309         // Get a bunch of conversations, some group, some individual and in different states.
1310         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1311             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1313         // Get all conversations for user1, limited to 1 result.
1314         $conversations = core_message\api::get_conversations($user1->id, 0, 1);
1316         // Verify the first conversation.
1317         $this->assertCount(1, $conversations);
1318         $conversation = array_shift($conversations);
1319         $this->assertEquals($conversation->id, $gc3->id);
1321         // Verify the next conversation.
1322         $conversations = \core_message\api::get_conversations($user1->id, 1, 1);
1323         $this->assertCount(1, $conversations);
1324         $this->assertEquals($gc2->id, $conversations[0]->id);
1326         // Verify the next conversation.
1327         $conversations = \core_message\api::get_conversations($user1->id, 2, 1);
1328         $this->assertCount(1, $conversations);
1329         $this->assertEquals($ic2->id, $conversations[0]->id);
1331         // Skip one and get both empty conversations.
1332         $conversations = \core_message\api::get_conversations($user1->id, 4, 2);
1333         $this->assertCount(2, $conversations);
1334         $this->assertEquals($gc5->id, $conversations[0]->id);
1335         $this->assertEmpty($conversations[0]->messages);
1336         $this->assertEquals($gc4->id, $conversations[1]->id);
1337         $this->assertEmpty($conversations[1]->messages);
1339         // Ask for an offset that doesn't exist and verify no conversations are returned.
1340         $conversations = \core_message\api::get_conversations($user1->id, 10, 1);
1341         $this->assertCount(0, $conversations);
1342     }
1344     /**
1345      * Test verifying the type filtering behaviour of the
1346      */
1347     public function test_get_conversations_type_filter() {
1348         // Get a bunch of conversations, some group, some individual and in different states.
1349         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1350             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1352         // Verify we can ask for only individual conversations.
1353         $conversations = \core_message\api::get_conversations($user1->id, 0, 20,
1354             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL);
1355         $this->assertCount(2, $conversations);
1357         // Verify we can ask for only group conversations.
1358         $conversations = \core_message\api::get_conversations($user1->id, 0, 20,
1359             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP);
1360         $this->assertCount(4, $conversations);
1362         // Verify an exception is thrown if an unrecognized type is specified.
1363         $this->expectException(\moodle_exception::class);
1364         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, 0);
1365     }
1367     /**
1368      * Tests retrieving conversations when a conversation contains a deleted user.
1369      */
1370     public function test_get_conversations_with_deleted_user() {
1371         // Get a bunch of conversations, some group, some individual and in different states.
1372         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1373             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1375         // Delete the second user and retrieve the conversations.
1376         // We should have 6 still, as conversations with soft-deleted users are still returned.
1377         // Group conversations are also present, albeit with less members.
1378         delete_user($user2);
1379         // This is to confirm an exception is not thrown when a user AND the user context is deleted.
1380         // We no longer delete the user context, but historically we did.
1381         context_helper::delete_instance(CONTEXT_USER, $user2->id);
1382         $conversations = \core_message\api::get_conversations($user1->id);
1383         $this->assertCount(6, $conversations);
1384         $this->assertEquals($gc3->id, $conversations[0]->id);
1385         $this->assertcount(1, $conversations[0]->members);
1386         $this->assertEquals($gc2->id, $conversations[1]->id);
1387         $this->assertcount(1, $conversations[1]->members);
1388         $this->assertEquals($ic2->id, $conversations[2]->id);
1389         $this->assertEquals($ic1->id, $conversations[3]->id);
1390         $this->assertEquals($gc5->id, $conversations[4]->id);
1391         $this->assertEquals($gc4->id, $conversations[5]->id);
1393         // Delete a user from a group conversation where that user had sent the most recent message.
1394         // This user will still be present in the members array, as will the message in the messages array.
1395         delete_user($user4);
1396         $conversations = \core_message\api::get_conversations($user1->id);
1397         $this->assertCount(6, $conversations);
1398         $this->assertEquals($gc2->id, $conversations[1]->id);
1399         $this->assertcount(1, $conversations[1]->members);
1400         $this->assertEquals($user4->id, $conversations[1]->members[$user4->id]->id);
1401         $this->assertcount(1, $conversations[1]->messages);
1402         $this->assertEquals($user4->id, $conversations[1]->messages[0]->useridfrom);
1404         // Delete the third user and retrieve the conversations.
1405         // We should have 6 still, as conversations with soft-deleted users are still returned.
1406         // Group conversations are also present, albeit with less members.
1407         delete_user($user3);
1408         $conversations = \core_message\api::get_conversations($user1->id);
1409         $this->assertCount(6, $conversations);
1410         $this->assertEquals($gc3->id, $conversations[0]->id);
1411         $this->assertcount(1, $conversations[0]->members);
1412         $this->assertEquals($gc2->id, $conversations[1]->id);
1413         $this->assertcount(1, $conversations[1]->members);
1414         $this->assertEquals($ic2->id, $conversations[2]->id);
1415         $this->assertEquals($ic1->id, $conversations[3]->id);
1416         $this->assertEquals($gc5->id, $conversations[4]->id);
1417         $this->assertEquals($gc4->id, $conversations[5]->id);
1418     }
1420     /**
1421      * Test confirming the behaviour of get_conversations() when users delete all messages.
1422      */
1423     public function test_get_conversations_deleted_messages() {
1424         // Get a bunch of conversations, some group, some individual and in different states.
1425         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1426             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1428         $conversations = \core_message\api::get_conversations($user1->id);
1429         $this->assertCount(6, $conversations);
1431         // Delete all messages from a group conversation the user is in - it should be returned.
1432         $this->assertTrue(\core_message\api::is_user_in_conversation($user1->id, $gc2->id));
1433         $convmessages = \core_message\api::get_conversation_messages($user1->id, $gc2->id);
1434         $messages = $convmessages['messages'];
1435         foreach ($messages as $message) {
1436             \core_message\api::delete_message($user1->id, $message->id);
1437         }
1438         $conversations = \core_message\api::get_conversations($user1->id);
1439         $this->assertCount(6, $conversations);
1440         $this->assertContains($gc2->id, array_column($conversations, 'id'));
1442         // Delete all messages from an individual conversation the user is in - it should not be returned.
1443         $this->assertTrue(\core_message\api::is_user_in_conversation($user1->id, $ic1->id));
1444         $convmessages = \core_message\api::get_conversation_messages($user1->id, $ic1->id);
1445         $messages = $convmessages['messages'];
1446         foreach ($messages as $message) {
1447             \core_message\api::delete_message($user1->id, $message->id);
1448         }
1449         $conversations = \core_message\api::get_conversations($user1->id);
1450         $this->assertCount(5, $conversations);
1451         $this->assertNotContains($ic1->id, array_column($conversations, 'id'));
1452     }
1454     /**
1455      * Test verifying the behaviour of get_conversations() when fetching favourite conversations with only a single
1456      * favourite.
1457      */
1458     public function test_get_conversations_favourite_conversations_single() {
1459         // Get a bunch of conversations, some group, some individual and in different states.
1460         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1461             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1463         // Mark a single conversation as favourites.
1464         \core_message\api::set_favourite_conversation($ic2->id, $user1->id);
1466         // Get the conversation, first with no restrictions, confirming the favourite status of the conversations.
1467         $conversations = \core_message\api::get_conversations($user1->id);
1468         $this->assertCount(6, $conversations);
1469         foreach ($conversations as $conv) {
1470             if (in_array($conv->id, [$ic2->id])) {
1471                 $this->assertTrue($conv->isfavourite);
1472             } else {
1473                 $this->assertFalse($conv->isfavourite);
1474             }
1475         }
1477         // Now, get ONLY favourite conversations.
1478         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, null, true);
1479         $this->assertCount(1, $conversations);
1480         foreach ($conversations as $conv) {
1481             $this->assertTrue($conv->isfavourite);
1482             $this->assertEquals($ic2->id, $conv->id);
1483         }
1485         // Now, try ONLY favourites of type 'group'.
1486         $conversations = \core_message\api::get_conversations($user1->id, 0, 20,
1487             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, true);
1488         $this->assertEmpty($conversations);
1490         // And NO favourite conversations.
1491         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, null, false);
1492         $this->assertCount(5, $conversations);
1493         foreach ($conversations as $conv) {
1494             $this->assertFalse($conv->isfavourite);
1495             $this->assertNotEquals($ic2, $conv->id);
1496         }
1497     }
1499     /**
1500      * Test verifying the behaviour of get_conversations() when fetching favourite conversations.
1501      */
1502     public function test_get_conversations_favourite_conversations() {
1503         // Get a bunch of conversations, some group, some individual and in different states.
1504         list($user1, $user2, $user3, $user4, $ic1, $ic2, $ic3,
1505             $gc1, $gc2, $gc3, $gc4, $gc5, $gc6) = $this->create_conversation_test_data();
1507         // Try to get ONLY favourite conversations, when no favourites exist.
1508         $this->assertEquals([], \core_message\api::get_conversations($user1->id, 0, 20, null, true));
1510         // Try to get NO favourite conversations, when no favourites exist.
1511         $this->assertCount(6, \core_message\api::get_conversations($user1->id, 0, 20, null, false));
1513         // Mark a few conversations as favourites.
1514         \core_message\api::set_favourite_conversation($ic1->id, $user1->id);
1515         \core_message\api::set_favourite_conversation($gc2->id, $user1->id);
1516         \core_message\api::set_favourite_conversation($gc5->id, $user1->id);
1517         $favouriteids = [$ic1->id, $gc2->id, $gc5->id];
1519         // Get the conversations, first with no restrictions, confirming the favourite status of the conversations.
1520         $conversations = \core_message\api::get_conversations($user1->id);
1521         $this->assertCount(6, $conversations);
1522         foreach ($conversations as $conv) {
1523             if (in_array($conv->id, $favouriteids)) {
1524                 $this->assertTrue($conv->isfavourite);
1525             } else {
1526                 $this->assertFalse($conv->isfavourite);
1527             }
1528         }
1530         // Now, get ONLY favourite conversations.
1531         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, null, true);
1532         $this->assertCount(3, $conversations);
1533         foreach ($conversations as $conv) {
1534             $this->assertTrue($conv->isfavourite);
1535             $this->assertNotFalse(array_search($conv->id, $favouriteids));
1536         }
1538         // Now, try ONLY favourites of type 'group'.
1539         $conversations = \core_message\api::get_conversations($user1->id, 0, 20,
1540             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP, true);
1541         $this->assertCount(2, $conversations);
1542         foreach ($conversations as $conv) {
1543             $this->assertTrue($conv->isfavourite);
1544             $this->assertNotFalse(array_search($conv->id, [$gc2->id, $gc5->id]));
1545         }
1547         // And NO favourite conversations.
1548         $conversations = \core_message\api::get_conversations($user1->id, 0, 20, null, false);
1549         $this->assertCount(3, $conversations);
1550         foreach ($conversations as $conv) {
1551             $this->assertFalse($conv->isfavourite);
1552             $this->assertFalse(array_search($conv->id, $favouriteids));
1553         }
1554     }
1556     /**
1557      * Test verifying get_conversations when there are users in a group and/or individual conversation. The reason this
1558      * test is performed is because we do not need as much data for group conversations (saving DB calls), so we want
1559      * to confirm this happens.
1560      */
1561     public function test_get_conversations_user_in_group_and_individual_chat() {
1562         $this->resetAfterTest();
1564         $user1 = self::getDataGenerator()->create_user();
1565         $user2 = self::getDataGenerator()->create_user();
1566         $user3 = self::getDataGenerator()->create_user();
1568         $conversation = \core_message\api::create_conversation(
1569             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1570             [
1571                 $user1->id,
1572                 $user2->id
1573             ],
1574             'Individual conversation'
1575         );
1577         testhelper::send_fake_message_to_conversation($user1, $conversation->id);
1579         $conversation = \core_message\api::create_conversation(
1580             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
1581             [
1582                 $user1->id,
1583                 $user2->id,
1584             ],
1585             'Group conversation'
1586         );
1588         testhelper::send_fake_message_to_conversation($user1, $conversation->id);
1590         \core_message\api::create_contact_request($user1->id, $user2->id);
1591         \core_message\api::create_contact_request($user1->id, $user3->id);
1593         $conversations = \core_message\api::get_conversations($user2->id);
1595         $groupconversation = array_shift($conversations);
1596         $individualconversation = array_shift($conversations);
1598         $this->assertEquals('Group conversation', $groupconversation->name);
1599         $this->assertEquals('Individual conversation', $individualconversation->name);
1601         $this->assertCount(1, $groupconversation->members);
1602         $this->assertCount(1, $individualconversation->members);
1604         $groupmember = reset($groupconversation->members);
1605         $this->assertNull($groupmember->requirescontact);
1606         $this->assertNull($groupmember->canmessage);
1607         $this->assertEmpty($groupmember->contactrequests);
1609         $individualmember = reset($individualconversation->members);
1610         $this->assertNotNull($individualmember->requirescontact);
1611         $this->assertNotNull($individualmember->canmessage);
1612         $this->assertNotEmpty($individualmember->contactrequests);
1613     }
1615     /**
1616      * Test verifying that group linked conversations are returned and contain a subname matching the course name.
1617      */
1618     public function test_get_conversations_group_linked() {
1619         global $CFG, $DB;
1621         // Create some users.
1622         $user1 = self::getDataGenerator()->create_user();
1623         $user2 = self::getDataGenerator()->create_user();
1624         $user3 = self::getDataGenerator()->create_user();
1626         $course1 = $this->getDataGenerator()->create_course();
1628         // Create a group with a linked conversation and a valid image.
1629         $this->setAdminUser();
1630         $this->getDataGenerator()->enrol_user($user1->id, $course1->id);
1631         $this->getDataGenerator()->enrol_user($user2->id, $course1->id);
1632         $this->getDataGenerator()->enrol_user($user3->id, $course1->id);
1633         $group1 = $this->getDataGenerator()->create_group([
1634             'courseid' => $course1->id,
1635             'enablemessaging' => 1,
1636             'picturepath' => $CFG->dirroot . '/lib/tests/fixtures/gd-logo.png'
1637         ]);
1639         // Add users to group1.
1640         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user1->id));
1641         $this->getDataGenerator()->create_group_member(array('groupid' => $group1->id, 'userid' => $user2->id));
1643         // Verify the group with the image works as expected.
1644         $conversations = \core_message\api::get_conversations($user1->id);
1645         $this->assertEquals(2, $conversations[0]->membercount);
1646         $this->assertEquals($course1->shortname, $conversations[0]->subname);
1647         $groupimageurl = get_group_picture_url($group1, $group1->courseid, true);
1648         $this->assertEquals($groupimageurl, $conversations[0]->imageurl);
1650         // Create a group with a linked conversation and without any image.
1651         $group2 = $this->getDataGenerator()->create_group([
1652             'courseid' => $course1->id,
1653             'enablemessaging' => 1,
1654         ]);
1656         // Add users to group2.
1657         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user2->id));
1658         $this->getDataGenerator()->create_group_member(array('groupid' => $group2->id, 'userid' => $user3->id));
1660         // Verify the group without any image works as expected too.
1661         $conversations = \core_message\api::get_conversations($user3->id);
1662         $this->assertEquals(2, $conversations[0]->membercount);
1663         $this->assertEquals($course1->shortname, $conversations[0]->subname);
1664         $groupimageurl = get_group_picture_url($group2, $group2->courseid, true);
1665         $this->assertEquals($groupimageurl, $conversations[0]->imageurl);
1667         // Now, disable the conversation linked to the group and verify it's no longer returned.
1668         $DB->set_field('message_conversations', 'enabled', 0, ['id' => $conversations[0]->id]);
1669         $conversations = \core_message\api::get_conversations($user3->id);
1670         $this->assertCount(0, $conversations);
1671     }
1673    /**
1674     * The data provider for get_conversations_mixed.
1675     *
1676     * This provides sets of data to for testing.
1677     * @return array
1678     */
1679    public function get_conversations_mixed_provider() {
1680        return array(
1681             'Test that conversations with messages contacts is correctly ordered.' => array(
1682                 'users' => array(
1683                     'user1',
1684                     'user2',
1685                     'user3',
1686                 ),
1687                 'contacts' => array(
1688                 ),
1689                 'messages' => array(
1690                     array(
1691                         'from'          => 'user1',
1692                         'to'            => 'user2',
1693                         'state'         => 'unread',
1694                         'subject'       => 'S1',
1695                     ),
1696                     array(
1697                         'from'          => 'user2',
1698                         'to'            => 'user1',
1699                         'state'         => 'unread',
1700                         'subject'       => 'S2',
1701                     ),
1702                     array(
1703                         'from'          => 'user1',
1704                         'to'            => 'user2',
1705                         'state'         => 'unread',
1706                         'timecreated'   => 0,
1707                         'subject'       => 'S3',
1708                     ),
1709                     array(
1710                         'from'          => 'user1',
1711                         'to'            => 'user3',
1712                         'state'         => 'read',
1713                         'timemodifier'  => 1,
1714                         'subject'       => 'S4',
1715                     ),
1716                     array(
1717                         'from'          => 'user3',
1718                         'to'            => 'user1',
1719                         'state'         => 'read',
1720                         'timemodifier'  => 1,
1721                         'subject'       => 'S5',
1722                     ),
1723                     array(
1724                         'from'          => 'user1',
1725                         'to'            => 'user3',
1726                         'state'         => 'read',
1727                         'timecreated'   => 0,
1728                         'subject'       => 'S6',
1729                     ),
1730                 ),
1731                 'expectations' => array(
1732                     'user1' => array(
1733                         // User1 has conversed most recently with user3. The most recent message is M5.
1734                         array(
1735                             'messageposition'   => 0,
1736                             'with'              => 'user3',
1737                             'subject'           => '<p>S5</p>',
1738                             'unreadcount'       => 0,
1739                         ),
1740                         // User1 has also conversed with user2. The most recent message is S2.
1741                         array(
1742                             'messageposition'   => 1,
1743                             'with'              => 'user2',
1744                             'subject'           => '<p>S2</p>',
1745                             'unreadcount'       => 1,
1746                         ),
1747                     ),
1748                     'user2' => array(
1749                         // User2 has only conversed with user1. Their most recent shared message was S2.
1750                         array(
1751                             'messageposition'   => 0,
1752                             'with'              => 'user1',
1753                             'subject'           => '<p>S2</p>',
1754                             'unreadcount'       => 2,
1755                         ),
1756                     ),
1757                     'user3' => array(
1758                         // User3 has only conversed with user1. Their most recent shared message was S5.
1759                         array(
1760                             'messageposition'   => 0,
1761                             'with'              => 'user1',
1762                             'subject'           => '<p>S5</p>',
1763                             'unreadcount'       => 0,
1764                         ),
1765                     ),
1766                 ),
1767             ),
1768             'Test conversations with a single user, where some messages are read and some are not.' => array(
1769                 'users' => array(
1770                     'user1',
1771                     'user2',
1772                 ),
1773                 'contacts' => array(
1774                 ),
1775                 'messages' => array(
1776                     array(
1777                         'from'          => 'user1',
1778                         'to'            => 'user2',
1779                         'state'         => 'read',
1780                         'subject'       => 'S1',
1781                     ),
1782                     array(
1783                         'from'          => 'user2',
1784                         'to'            => 'user1',
1785                         'state'         => 'read',
1786                         'subject'       => 'S2',
1787                     ),
1788                     array(
1789                         'from'          => 'user1',
1790                         'to'            => 'user2',
1791                         'state'         => 'unread',
1792                         'timemodifier'  => 1,
1793                         'subject'       => 'S3',
1794                     ),
1795                     array(
1796                         'from'          => 'user1',
1797                         'to'            => 'user2',
1798                         'state'         => 'unread',
1799                         'timemodifier'  => 1,
1800                         'subject'       => 'S4',
1801                     ),
1802                 ),
1803                 'expectations' => array(
1804                     // The most recent message between user1 and user2 was S4.
1805                     'user1' => array(
1806                         array(
1807                             'messageposition'   => 0,
1808                             'with'              => 'user2',
1809                             'subject'           => '<p>S4</p>',
1810                             'unreadcount'       => 0,
1811                         ),
1812                     ),
1813                     'user2' => array(
1814                         // The most recent message between user1 and user2 was S4.
1815                         array(
1816                             'messageposition'   => 0,
1817                             'with'              => 'user1',
1818                             'subject'           => '<p>S4</p>',
1819                             'unreadcount'       => 2,
1820                         ),
1821                     ),
1822                 ),
1823             ),
1824             'Test conversations with a single user, where some messages are read and some are not, and messages ' .
1825             'are out of order' => array(
1826             // This can happen through a combination of factors including multi-master DB replication with messages
1827             // read somehow (e.g. API).
1828                 'users' => array(
1829                     'user1',
1830                     'user2',
1831                 ),
1832                 'contacts' => array(
1833                 ),
1834                 'messages' => array(
1835                     array(
1836                         'from'          => 'user1',
1837                         'to'            => 'user2',
1838                         'state'         => 'read',
1839                         'subject'       => 'S1',
1840                         'timemodifier'  => 1,
1841                     ),
1842                     array(
1843                         'from'          => 'user2',
1844                         'to'            => 'user1',
1845                         'state'         => 'read',
1846                         'subject'       => 'S2',
1847                         'timemodifier'  => 2,
1848                     ),
1849                     array(
1850                         'from'          => 'user1',
1851                         'to'            => 'user2',
1852                         'state'         => 'unread',
1853                         'subject'       => 'S3',
1854                     ),
1855                     array(
1856                         'from'          => 'user1',
1857                         'to'            => 'user2',
1858                         'state'         => 'unread',
1859                         'subject'       => 'S4',
1860                     ),
1861                 ),
1862                 'expectations' => array(
1863                     // The most recent message between user1 and user2 was S2, even though later IDs have not been read.
1864                     'user1' => array(
1865                         array(
1866                             'messageposition'   => 0,
1867                             'with'              => 'user2',
1868                             'subject'           => '<p>S2</p>',
1869                             'unreadcount'       => 0,
1870                         ),
1871                     ),
1872                     'user2' => array(
1873                         array(
1874                             'messageposition'   => 0,
1875                             'with'              => 'user1',
1876                             'subject'           => '<p>S2</p>',
1877                             'unreadcount'       => 2
1878                         ),
1879                     ),
1880                 ),
1881             ),
1882             'Test unread message count is correct for both users' => array(
1883                 'users' => array(
1884                     'user1',
1885                     'user2',
1886                 ),
1887                 'contacts' => array(
1888                 ),
1889                 'messages' => array(
1890                     array(
1891                         'from'          => 'user1',
1892                         'to'            => 'user2',
1893                         'state'         => 'read',
1894                         'subject'       => 'S1',
1895                         'timemodifier'  => 1,
1896                     ),
1897                     array(
1898                         'from'          => 'user2',
1899                         'to'            => 'user1',
1900                         'state'         => 'read',
1901                         'subject'       => 'S2',
1902                         'timemodifier'  => 2,
1903                     ),
1904                     array(
1905                         'from'          => 'user1',
1906                         'to'            => 'user2',
1907                         'state'         => 'read',
1908                         'subject'       => 'S3',
1909                         'timemodifier'  => 3,
1910                     ),
1911                     array(
1912                         'from'          => 'user1',
1913                         'to'            => 'user2',
1914                         'state'         => 'read',
1915                         'subject'       => 'S4',
1916                         'timemodifier'  => 4,
1917                     ),
1918                     array(
1919                         'from'          => 'user1',
1920                         'to'            => 'user2',
1921                         'state'         => 'unread',
1922                         'subject'       => 'S5',
1923                         'timemodifier'  => 5,
1924                     ),
1925                     array(
1926                         'from'          => 'user2',
1927                         'to'            => 'user1',
1928                         'state'         => 'unread',
1929                         'subject'       => 'S6',
1930                         'timemodifier'  => 6,
1931                     ),
1932                     array(
1933                         'from'          => 'user1',
1934                         'to'            => 'user2',
1935                         'state'         => 'unread',
1936                         'subject'       => 'S7',
1937                         'timemodifier'  => 7,
1938                     ),
1939                     array(
1940                         'from'          => 'user1',
1941                         'to'            => 'user2',
1942                         'state'         => 'unread',
1943                         'subject'       => 'S8',
1944                         'timemodifier'  => 8,
1945                     ),
1946                 ),
1947                 'expectations' => array(
1948                     // The most recent message between user1 and user2 was S2, even though later IDs have not been read.
1949                     'user1' => array(
1950                         array(
1951                             'messageposition'   => 0,
1952                             'with'              => 'user2',
1953                             'subject'           => '<p>S8</p>',
1954                             'unreadcount'       => 1,
1955                         ),
1956                     ),
1957                     'user2' => array(
1958                         array(
1959                             'messageposition'   => 0,
1960                             'with'              => 'user1',
1961                             'subject'           => '<p>S8</p>',
1962                             'unreadcount'       => 3,
1963                         ),
1964                     ),
1965                 ),
1966             ),
1967         );
1968     }
1970     /**
1971      * Test get_conversations with a mixture of messages.
1972      *
1973      * @dataProvider get_conversations_mixed_provider
1974      * @param array $usersdata The list of users to create for this test.
1975      * @param array $messagesdata The list of messages to create.
1976      * @param array $expectations The list of expected outcomes.
1977      */
1978     public function test_get_conversations_mixed($usersdata, $contacts, $messagesdata, $expectations) {
1979         global $DB;
1981         // Create all of the users.
1982         $users = array();
1983         foreach ($usersdata as $username) {
1984             $users[$username] = $this->getDataGenerator()->create_user(array('username' => $username));
1985         }
1987         foreach ($contacts as $username => $contact) {
1988             foreach ($contact as $contactname => $blocked) {
1989                 $record = new stdClass();
1990                 $record->userid     = $users[$username]->id;
1991                 $record->contactid  = $users[$contactname]->id;
1992                 $record->blocked    = $blocked;
1993                 $record->id = $DB->insert_record('message_contacts', $record);
1994             }
1995         }
1997         $defaulttimecreated = time();
1998         foreach ($messagesdata as $messagedata) {
1999             $from       = $users[$messagedata['from']];
2000             $to         = $users[$messagedata['to']];
2001             $subject    = $messagedata['subject'];
2003             if (isset($messagedata['state']) && $messagedata['state'] == 'unread') {
2004                 $messageid = $this->send_fake_message($from, $to, $subject);
2005             } else {
2006                 // If there is no state, or the state is not 'unread', assume the message is read.
2007                 $messageid = message_post_message($from, $to, $subject, FORMAT_PLAIN);
2008             }
2010             $updatemessage = new stdClass();
2011             $updatemessage->id = $messageid;
2012             if (isset($messagedata['timecreated'])) {
2013                 $updatemessage->timecreated = $messagedata['timecreated'];
2014             } else if (isset($messagedata['timemodifier'])) {
2015                 $updatemessage->timecreated = $defaulttimecreated + $messagedata['timemodifier'];
2016             } else {
2017                 $updatemessage->timecreated = $defaulttimecreated;
2018             }
2020             $DB->update_record('messages', $updatemessage);
2021         }
2023         foreach ($expectations as $username => $data) {
2024             // Get the recent conversations for the specified user.
2025             $user = $users[$username];
2026             $conversations = array_values(\core_message\api::get_conversations($user->id));
2027             foreach ($data as $expectation) {
2028                 $otheruser = $users[$expectation['with']];
2029                 $conversation = $conversations[$expectation['messageposition']];
2030                 $this->assertEquals($otheruser->id, $conversation->members[$otheruser->id]->id);
2031                 $this->assertEquals($expectation['subject'], $conversation->messages[0]->text);
2032                 $this->assertEquals($expectation['unreadcount'], $conversation->unreadcount);
2033             }
2034         }
2035     }
2037     /**
2038      * Tests retrieving contacts.
2039      */
2040     public function test_get_contacts() {
2041         // Create some users.
2042         $user1 = self::getDataGenerator()->create_user();
2044         // Set as the user.
2045         $this->setUser($user1);
2047         $user2 = new stdClass();
2048         $user2->firstname = 'User';
2049         $user2->lastname = 'A';
2050         $user2 = self::getDataGenerator()->create_user($user2);
2052         $user3 = new stdClass();
2053         $user3->firstname = 'User';
2054         $user3->lastname = 'B';
2055         $user3 = self::getDataGenerator()->create_user($user3);
2057         $user4 = new stdClass();
2058         $user4->firstname = 'User';
2059         $user4->lastname = 'C';
2060         $user4 = self::getDataGenerator()->create_user($user4);
2062         $user5 = new stdClass();
2063         $user5->firstname = 'User';
2064         $user5->lastname = 'D';
2065         $user5 = self::getDataGenerator()->create_user($user5);
2067         // Add some users as contacts.
2068         \core_message\api::add_contact($user1->id, $user2->id);
2069         \core_message\api::add_contact($user1->id, $user3->id);
2070         \core_message\api::add_contact($user1->id, $user4->id);
2072         // Retrieve the contacts.
2073         $contacts = \core_message\api::get_contacts($user1->id);
2075         // Confirm the data is correct.
2076         $this->assertEquals(3, count($contacts));
2077         usort($contacts, ['static', 'sort_contacts']);
2079         $contact1 = $contacts[0];
2080         $contact2 = $contacts[1];
2081         $contact3 = $contacts[2];
2083         $this->assertEquals($user2->id, $contact1->userid);
2084         $this->assertEmpty($contact1->useridfrom);
2085         $this->assertFalse($contact1->ismessaging);
2086         $this->assertNull($contact1->lastmessage);
2087         $this->assertNull($contact1->messageid);
2088         $this->assertNull($contact1->isonline);
2089         $this->assertFalse($contact1->isread);
2090         $this->assertFalse($contact1->isblocked);
2091         $this->assertNull($contact1->unreadcount);
2093         $this->assertEquals($user3->id, $contact2->userid);
2094         $this->assertEmpty($contact2->useridfrom);
2095         $this->assertFalse($contact2->ismessaging);
2096         $this->assertNull($contact2->lastmessage);
2097         $this->assertNull($contact2->messageid);
2098         $this->assertNull($contact2->isonline);
2099         $this->assertFalse($contact2->isread);
2100         $this->assertFalse($contact2->isblocked);
2101         $this->assertNull($contact2->unreadcount);
2103         $this->assertEquals($user4->id, $contact3->userid);
2104         $this->assertEmpty($contact3->useridfrom);
2105         $this->assertFalse($contact3->ismessaging);
2106         $this->assertNull($contact3->lastmessage);
2107         $this->assertNull($contact3->messageid);
2108         $this->assertNull($contact3->isonline);
2109         $this->assertFalse($contact3->isread);
2110         $this->assertFalse($contact3->isblocked);
2111         $this->assertNull($contact3->unreadcount);
2112     }
2114     /**
2115      * Tests retrieving messages.
2116      */
2117     public function test_get_messages() {
2118         // Create some users.
2119         $user1 = self::getDataGenerator()->create_user();
2120         $user2 = self::getDataGenerator()->create_user();
2122         // The person doing the search.
2123         $this->setUser($user1);
2125         // Send some messages back and forth.
2126         $time = 1;
2127         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
2128         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
2129         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
2130         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
2132         // Retrieve the messages.
2133         $messages = \core_message\api::get_messages($user1->id, $user2->id);
2135         // Confirm the message data is correct.
2136         $this->assertEquals(4, count($messages));
2138         $message1 = $messages[0];
2139         $message2 = $messages[1];
2140         $message3 = $messages[2];
2141         $message4 = $messages[3];
2143         $this->assertEquals($user1->id, $message1->useridfrom);
2144         $this->assertEquals($user2->id, $message1->useridto);
2145         $this->assertTrue($message1->displayblocktime);
2146         $this->assertContains('Yo!', $message1->text);
2148         $this->assertEquals($user2->id, $message2->useridfrom);
2149         $this->assertEquals($user1->id, $message2->useridto);
2150         $this->assertFalse($message2->displayblocktime);
2151         $this->assertContains('Sup mang?', $message2->text);
2153         $this->assertEquals($user1->id, $message3->useridfrom);
2154         $this->assertEquals($user2->id, $message3->useridto);
2155         $this->assertFalse($message3->displayblocktime);
2156         $this->assertContains('Writing PHPUnit tests!', $message3->text);
2158         $this->assertEquals($user2->id, $message4->useridfrom);
2159         $this->assertEquals($user1->id, $message4->useridto);
2160         $this->assertFalse($message4->displayblocktime);
2161         $this->assertContains('Word.', $message4->text);
2162     }
2164     /**
2165      * Tests retrieving conversation messages.
2166      */
2167     public function test_get_conversation_messages() {
2168         // Create some users.
2169         $user1 = self::getDataGenerator()->create_user();
2170         $user2 = self::getDataGenerator()->create_user();
2172         // Create conversation.
2173         $conversation = \core_message\api::create_conversation(
2174             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
2175             [$user1->id, $user2->id]
2176         );
2178         // The person doing the search.
2179         $this->setUser($user1);
2181         // Send some messages back and forth.
2182         $time = 1;
2183         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Yo!', $time + 1);
2184         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Sup mang?', $time + 2);
2185         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Writing PHPUnit tests!', $time + 3);
2186         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Word.', $time + 4);
2188         // Retrieve the messages.
2189         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id);
2191         // Confirm the conversation id is correct.
2192         $this->assertEquals($conversation->id, $convmessages['id']);
2194         // Confirm the message data is correct.
2195         $messages = $convmessages['messages'];
2196         $this->assertEquals(4, count($messages));
2197         $message1 = $messages[0];
2198         $message2 = $messages[1];
2199         $message3 = $messages[2];
2200         $message4 = $messages[3];
2202         $this->assertEquals($user1->id, $message1->useridfrom);
2203         $this->assertContains('Yo!', $message1->text);
2205         $this->assertEquals($user2->id, $message2->useridfrom);
2206         $this->assertContains('Sup mang?', $message2->text);
2208         $this->assertEquals($user1->id, $message3->useridfrom);
2209         $this->assertContains('Writing PHPUnit tests!', $message3->text);
2211         $this->assertEquals($user1->id, $message4->useridfrom);
2212         $this->assertContains('Word.', $message4->text);
2214         // Confirm the members data is correct.
2215         $members = $convmessages['members'];
2216         $this->assertEquals(2, count($members));
2217     }
2219     /**
2220      * Tests retrieving group conversation messages.
2221      */
2222     public function test_get_group_conversation_messages() {
2223         // Create some users.
2224         $user1 = self::getDataGenerator()->create_user();
2225         $user2 = self::getDataGenerator()->create_user();
2226         $user3 = self::getDataGenerator()->create_user();
2227         $user4 = self::getDataGenerator()->create_user();
2229         // Create group conversation.
2230         $conversation = \core_message\api::create_conversation(
2231             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2232             [$user1->id, $user2->id, $user3->id, $user4->id]
2233         );
2235         // The person doing the search.
2236         $this->setUser($user1);
2238         // Send some messages back and forth.
2239         $time = 1;
2240         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Yo!', $time + 1);
2241         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Sup mang?', $time + 2);
2242         testhelper::send_fake_message_to_conversation($user3, $conversation->id, 'Writing PHPUnit tests!', $time + 3);
2243         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Word.', $time + 4);
2244         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Yeah!', $time + 5);
2246         // Retrieve the messages.
2247         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id);
2249         // Confirm the conversation id is correct.
2250         $this->assertEquals($conversation->id, $convmessages['id']);
2252         // Confirm the message data is correct.
2253         $messages = $convmessages['messages'];
2254         $this->assertEquals(5, count($messages));
2256         $message1 = $messages[0];
2257         $message2 = $messages[1];
2258         $message3 = $messages[2];
2259         $message4 = $messages[3];
2260         $message5 = $messages[4];
2262         $this->assertEquals($user1->id, $message1->useridfrom);
2263         $this->assertContains('Yo!', $message1->text);
2265         $this->assertEquals($user2->id, $message2->useridfrom);
2266         $this->assertContains('Sup mang?', $message2->text);
2268         $this->assertEquals($user3->id, $message3->useridfrom);
2269         $this->assertContains('Writing PHPUnit tests!', $message3->text);
2271         $this->assertEquals($user1->id, $message4->useridfrom);
2272         $this->assertContains('Word.', $message4->text);
2274         $this->assertEquals($user2->id, $message5->useridfrom);
2275         $this->assertContains('Yeah!', $message5->text);
2277         // Confirm the members data is correct.
2278         $members = $convmessages['members'];
2279         $this->assertEquals(3, count($members));
2280     }
2282     /**
2283      * Test verifying the sorting param for get_conversation_messages is respected().
2284      */
2285     public function test_get_conversation_messages_sorting() {
2286         // Create some users.
2287         $user1 = self::getDataGenerator()->create_user();
2288         $user2 = self::getDataGenerator()->create_user();
2289         $user3 = self::getDataGenerator()->create_user();
2291         // Create conversations - 1 group and 1 individual.
2292         $conversation = \core_message\api::create_conversation(
2293             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
2294             [$user1->id, $user2->id]
2295         );
2296         $conversation2 = \core_message\api::create_conversation(
2297             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2298             [$user1->id, $user2->id, $user3->id]
2299         );
2301         // Send some messages back and forth.
2302         $time = 1;
2303         $m1id = testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Yo!', $time + 1);
2304         $m2id = testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Sup mang?', $time + 2);
2305         $m3id = testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Writing PHPUnit tests!', $time + 3);
2306         $m4id = testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Word.', $time + 4);
2308         $gm1id = testhelper::send_fake_message_to_conversation($user1, $conversation2->id, 'Yo!', $time + 1);
2309         $gm2id = testhelper::send_fake_message_to_conversation($user2, $conversation2->id, 'Sup mang?', $time + 2);
2310         $gm3id = testhelper::send_fake_message_to_conversation($user3, $conversation2->id, 'Writing PHPUnit tests!', $time + 3);
2311         $gm4id = testhelper::send_fake_message_to_conversation($user1, $conversation2->id, 'Word.', $time + 4);
2313         // The person doing the search.
2314         $this->setUser($user1);
2316         // Retrieve the messages using default sort ('timecreated ASC') and verify ordering.
2317         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id);
2318         $messages = $convmessages['messages'];
2319         $this->assertEquals($m1id, $messages[0]->id);
2320         $this->assertEquals($m2id, $messages[1]->id);
2321         $this->assertEquals($m3id, $messages[2]->id);
2322         $this->assertEquals($m4id, $messages[3]->id);
2324         // Retrieve the messages without specifying DESC sort ordering, and verify ordering.
2325         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 0, 0, 'timecreated DESC');
2326         $messages = $convmessages['messages'];
2327         $this->assertEquals($m1id, $messages[3]->id);
2328         $this->assertEquals($m2id, $messages[2]->id);
2329         $this->assertEquals($m3id, $messages[1]->id);
2330         $this->assertEquals($m4id, $messages[0]->id);
2332         // Retrieve the messages using default sort ('timecreated ASC') and verify ordering.
2333         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation2->id);
2334         $messages = $convmessages['messages'];
2335         $this->assertEquals($gm1id, $messages[0]->id);
2336         $this->assertEquals($gm2id, $messages[1]->id);
2337         $this->assertEquals($gm3id, $messages[2]->id);
2338         $this->assertEquals($gm4id, $messages[3]->id);
2340         // Retrieve the messages without specifying DESC sort ordering, and verify ordering.
2341         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation2->id, 0, 0, 'timecreated DESC');
2342         $messages = $convmessages['messages'];
2343         $this->assertEquals($gm1id, $messages[3]->id);
2344         $this->assertEquals($gm2id, $messages[2]->id);
2345         $this->assertEquals($gm3id, $messages[1]->id);
2346         $this->assertEquals($gm4id, $messages[0]->id);
2347     }
2349     /**
2350      * Test retrieving conversation messages by providing a minimum timecreated value.
2351      */
2352     public function test_get_conversation_messages_time_from_only() {
2353         // Create some users.
2354         $user1 = self::getDataGenerator()->create_user();
2355         $user2 = self::getDataGenerator()->create_user();
2356         $user3 = self::getDataGenerator()->create_user();
2357         $user4 = self::getDataGenerator()->create_user();
2359         // Create group conversation.
2360         $conversation = \core_message\api::create_conversation(
2361             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2362             [$user1->id, $user2->id, $user3->id, $user4->id]
2363         );
2365         // The person doing the search.
2366         $this->setUser($user1);
2368         // Send some messages back and forth.
2369         $time = 1;
2370         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 1', $time + 1);
2371         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Message 2', $time + 2);
2372         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 3', $time + 3);
2373         testhelper::send_fake_message_to_conversation($user3, $conversation->id, 'Message 4', $time + 4);
2375         // Retrieve the messages from $time, which should be all of them.
2376         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 0, 0, 'timecreated ASC', $time);
2378         // Confirm the conversation id is correct.
2379         $this->assertEquals($conversation->id, $convmessages['id']);
2381         // Confirm the message data is correct.
2382         $messages = $convmessages['messages'];
2383         $this->assertEquals(4, count($messages));
2385         $message1 = $messages[0];
2386         $message2 = $messages[1];
2387         $message3 = $messages[2];
2388         $message4 = $messages[3];
2390         $this->assertContains('Message 1', $message1->text);
2391         $this->assertContains('Message 2', $message2->text);
2392         $this->assertContains('Message 3', $message3->text);
2393         $this->assertContains('Message 4', $message4->text);
2395         // Confirm the members data is correct.
2396         $members = $convmessages['members'];
2397         $this->assertEquals(3, count($members));
2399         // Retrieve the messages from $time + 3, which should only be the 2 last messages.
2400         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 0, 0,
2401             'timecreated ASC', $time + 3);
2403         // Confirm the conversation id is correct.
2404         $this->assertEquals($conversation->id, $convmessages['id']);
2406         // Confirm the message data is correct.
2407         $messages = $convmessages['messages'];
2408         $this->assertEquals(2, count($messages));
2410         $message1 = $messages[0];
2411         $message2 = $messages[1];
2413         $this->assertContains('Message 3', $message1->text);
2414         $this->assertContains('Message 4', $message2->text);
2416         // Confirm the members data is correct.
2417         $members = $convmessages['members'];
2418         $this->assertEquals(2, count($members));
2419     }
2421     /**
2422      * Test retrieving conversation messages by providing a maximum timecreated value.
2423      */
2424     public function test_get_conversation_messages_time_to_only() {
2425         // Create some users.
2426         $user1 = self::getDataGenerator()->create_user();
2427         $user2 = self::getDataGenerator()->create_user();
2428         $user3 = self::getDataGenerator()->create_user();
2429         $user4 = self::getDataGenerator()->create_user();
2431         // Create group conversation.
2432         $conversation = \core_message\api::create_conversation(
2433             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2434             [$user1->id, $user2->id, $user3->id, $user4->id]
2435         );
2437         // The person doing the search.
2438         $this->setUser($user1);
2440         // Send some messages back and forth.
2441         $time = 1;
2442         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 1', $time + 1);
2443         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Message 2', $time + 2);
2444         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 3', $time + 3);
2445         testhelper::send_fake_message_to_conversation($user3, $conversation->id, 'Message 4', $time + 4);
2447         // Retrieve the messages up until $time + 4, which should be all of them.
2448         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 0, 0, 'timecreated ASC',
2449             0, $time + 4);
2451         // Confirm the conversation id is correct.
2452         $this->assertEquals($conversation->id, $convmessages['id']);
2454         // Confirm the message data is correct.
2455         $messages = $convmessages['messages'];
2456         $this->assertEquals(4, count($messages));
2458         $message1 = $messages[0];
2459         $message2 = $messages[1];
2460         $message3 = $messages[2];
2461         $message4 = $messages[3];
2463         $this->assertContains('Message 1', $message1->text);
2464         $this->assertContains('Message 2', $message2->text);
2465         $this->assertContains('Message 3', $message3->text);
2466         $this->assertContains('Message 4', $message4->text);
2468         // Confirm the members data is correct.
2469         $members = $convmessages['members'];
2470         $this->assertEquals(3, count($members));
2472         // Retrieve the messages up until $time + 2, which should be the first two.
2473         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 0, 0, 'timecreated ASC',
2474             0, $time + 2);
2476         // Confirm the conversation id is correct.
2477         $this->assertEquals($conversation->id, $convmessages['id']);
2479         // Confirm the message data is correct.
2480         $messages = $convmessages['messages'];
2481         $this->assertEquals(2, count($messages));
2483         $message1 = $messages[0];
2484         $message2 = $messages[1];
2486         $this->assertContains('Message 1', $message1->text);
2487         $this->assertContains('Message 2', $message2->text);
2489         // Confirm the members data is correct.
2490         $members = $convmessages['members'];
2491         $this->assertEquals(2, count($members));
2492     }
2494     /**
2495      * Test retrieving conversation messages by providing a minimum and maximum timecreated value.
2496      */
2497     public function test_get_conversation_messages_time_from_and_to() {
2498         // Create some users.
2499         $user1 = self::getDataGenerator()->create_user();
2500         $user2 = self::getDataGenerator()->create_user();
2501         $user3 = self::getDataGenerator()->create_user();
2502         $user4 = self::getDataGenerator()->create_user();
2504         // Create group conversation.
2505         $conversation = \core_message\api::create_conversation(
2506             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2507             [$user1->id, $user2->id, $user3->id, $user4->id]
2508         );
2510         // The person doing the search.
2511         $this->setUser($user1);
2513         // Send some messages back and forth.
2514         $time = 1;
2515         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 1', $time + 1);
2516         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Message 2', $time + 2);
2517         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 3', $time + 3);
2518         testhelper::send_fake_message_to_conversation($user3, $conversation->id, 'Message 4', $time + 4);
2520         // Retrieve the messages from $time + 2 up until $time + 3, which should be 2nd and 3rd message.
2521         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 0, 0,
2522             'timecreated ASC', $time + 2, $time + 3);
2524         // Confirm the conversation id is correct.
2525         $this->assertEquals($conversation->id, $convmessages['id']);
2527         // Confirm the message data is correct.
2528         $messages = $convmessages['messages'];
2529         $this->assertEquals(2, count($messages));
2531         $message1 = $messages[0];
2532         $message2 = $messages[1];
2534         $this->assertContains('Message 2', $message1->text);
2535         $this->assertContains('Message 3', $message2->text);
2537         // Confirm the members data is correct.
2538         $members = $convmessages['members'];
2539         $this->assertEquals(2, count($members));
2540     }
2543     /**
2544      * Test retrieving conversation messages by providing a limitfrom value.
2545      */
2546     public function test_get_conversation_messages_limitfrom_only() {
2547         // Create some users.
2548         $user1 = self::getDataGenerator()->create_user();
2549         $user2 = self::getDataGenerator()->create_user();
2550         $user3 = self::getDataGenerator()->create_user();
2551         $user4 = self::getDataGenerator()->create_user();
2553         // Create group conversation.
2554         $conversation = \core_message\api::create_conversation(
2555             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2556             [$user1->id, $user2->id, $user3->id, $user4->id]
2557         );
2559         // The person doing the search.
2560         $this->setUser($user1);
2562         // Send some messages back and forth.
2563         $time = 1;
2564         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 1', $time + 1);
2565         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Message 2', $time + 2);
2566         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 3', $time + 3);
2567         testhelper::send_fake_message_to_conversation($user3, $conversation->id, 'Message 4', $time + 4);
2569         // Retrieve the messages from $time, which should be all of them.
2570         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 2);
2572         // Confirm the conversation id is correct.
2573         $messages = $convmessages['messages'];
2574         $this->assertEquals($conversation->id, $convmessages['id']);
2576         // Confirm the message data is correct.
2577         $this->assertEquals(2, count($messages));
2579         $message1 = $messages[0];
2580         $message2 = $messages[1];
2582         $this->assertContains('Message 3', $message1->text);
2583         $this->assertContains('Message 4', $message2->text);
2585         // Confirm the members data is correct.
2586         $members = $convmessages['members'];
2587         $this->assertEquals(2, count($members));
2588     }
2590     /**
2591      * Test retrieving conversation messages by providing a limitnum value.
2592      */
2593     public function test_get_conversation_messages_limitnum() {
2594         // Create some users.
2595         $user1 = self::getDataGenerator()->create_user();
2596         $user2 = self::getDataGenerator()->create_user();
2597         $user3 = self::getDataGenerator()->create_user();
2598         $user4 = self::getDataGenerator()->create_user();
2600         // Create group conversation.
2601         $conversation = \core_message\api::create_conversation(
2602             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2603             [$user1->id, $user2->id, $user3->id, $user4->id]
2604         );
2606         // The person doing the search.
2607         $this->setUser($user1);
2609         // Send some messages back and forth.
2610         $time = 1;
2611         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 1', $time + 1);
2612         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Message 2', $time + 2);
2613         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Message 3', $time + 3);
2614         testhelper::send_fake_message_to_conversation($user3, $conversation->id, 'Message 4', $time + 4);
2616         // Retrieve the messages from $time, which should be all of them.
2617         $convmessages = \core_message\api::get_conversation_messages($user1->id, $conversation->id, 2, 1);
2619         // Confirm the conversation id is correct.
2620         $messages = $convmessages['messages'];
2621         $this->assertEquals($conversation->id, $convmessages['id']);
2623         // Confirm the message data is correct.
2624         $messages = $convmessages['messages'];
2625         $this->assertEquals(1, count($messages));
2627         $message1 = $messages[0];
2629         $this->assertContains('Message 3', $message1->text);
2631         // Confirm the members data is correct.
2632         $members = $convmessages['members'];
2633         $this->assertEquals(1, count($members));
2634     }
2636     /**
2637      * Tests retrieving most recent message.
2638      */
2639     public function test_get_most_recent_message() {
2640         // Create some users.
2641         $user1 = self::getDataGenerator()->create_user();
2642         $user2 = self::getDataGenerator()->create_user();
2644         // The person doing the search.
2645         $this->setUser($user1);
2647         // Send some messages back and forth.
2648         $time = 1;
2649         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
2650         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
2651         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
2652         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
2654         // Retrieve the most recent messages.
2655         $message = \core_message\api::get_most_recent_message($user1->id, $user2->id);
2657         // Check the results are correct.
2658         $this->assertEquals($user2->id, $message->useridfrom);
2659         $this->assertEquals($user1->id, $message->useridto);
2660         $this->assertContains('Word.', $message->text);
2661     }
2663     /**
2664      * Tests retrieving most recent conversation message.
2665      */
2666     public function test_get_most_recent_conversation_message() {
2667         // Create some users.
2668         $user1 = self::getDataGenerator()->create_user();
2669         $user2 = self::getDataGenerator()->create_user();
2670         $user3 = self::getDataGenerator()->create_user();
2672         // Create group conversation.
2673         $conversation = \core_message\api::create_conversation(
2674             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
2675             [$user1->id, $user2->id, $user3->id]
2676         );
2678         // The person getting the most recent conversation message.
2679         $this->setUser($user1);
2681         // Send some messages back and forth.
2682         $time = 1;
2683         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Yo!', $time + 1);
2684         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Sup mang?', $time + 2);
2685         testhelper::send_fake_message_to_conversation($user1, $conversation->id, 'Writing PHPUnit tests!', $time + 3);
2686         testhelper::send_fake_message_to_conversation($user2, $conversation->id, 'Word.', $time + 4);
2688         // Retrieve the most recent messages.
2689         $message = \core_message\api::get_most_recent_conversation_message($conversation->id, $user1->id);
2691         // Check the results are correct.
2692         $this->assertEquals($user2->id, $message->useridfrom);
2693         $this->assertContains('Word.', $message->text);
2694     }
2696     /**
2697      * Tests retrieving a user's profile.
2698      */
2699     public function test_get_profile() {
2700         // Create some users.
2701         $user1 = self::getDataGenerator()->create_user();
2703         $user2 = new stdClass();
2704         $user2->country = 'AU';
2705         $user2->city = 'Perth';
2706         $user2 = self::getDataGenerator()->create_user($user2);
2708         // The person doing the search.
2709         $this->setUser($user1);
2711         // Get the profile.
2712         $profile = \core_message\api::get_profile($user1->id, $user2->id);
2714         $this->assertEquals($user2->id, $profile->userid);
2715         $this->assertEmpty($profile->email);
2716         $this->assertEmpty($profile->country);
2717         $this->assertEmpty($profile->city);
2718         $this->assertEquals(fullname($user2), $profile->fullname);
2719         $this->assertNull($profile->isonline);
2720         $this->assertFalse($profile->isblocked);
2721         $this->assertFalse($profile->iscontact);
2722     }
2724     /**
2725      * Tests retrieving a user's profile.
2726      */
2727     public function test_get_profile_as_admin() {
2728         // The person doing the search.
2729         $this->setAdminUser();
2731         // Create some users.
2732         $user1 = self::getDataGenerator()->create_user();
2734         $user2 = new stdClass();
2735         $user2->country = 'AU';
2736         $user2->city = 'Perth';
2737         $user2 = self::getDataGenerator()->create_user($user2);
2739         // Get the profile.
2740         $profile = \core_message\api::get_profile($user1->id, $user2->id);
2742         $this->assertEquals($user2->id, $profile->userid);
2743         $this->assertEquals($user2->email, $profile->email);
2744         $this->assertEquals($user2->country, $profile->country);
2745         $this->assertEquals($user2->city, $profile->city);
2746         $this->assertEquals(fullname($user2), $profile->fullname);
2747         $this->assertFalse($profile->isonline);
2748         $this->assertFalse($profile->isblocked);
2749         $this->assertFalse($profile->iscontact);
2750     }
2752     /**
2753      * Tests checking if a user can mark all messages as read.
2754      */
2755     public function test_can_mark_all_messages_as_read() {
2756         // Set as the admin.
2757         $this->setAdminUser();
2759         // Create some users.
2760         $user1 = self::getDataGenerator()->create_user();
2761         $user2 = self::getDataGenerator()->create_user();
2762         $user3 = self::getDataGenerator()->create_user();
2764         // Send some messages back and forth.
2765         $time = 1;
2766         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
2767         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
2768         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
2769         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
2771         $conversationid = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
2773         // The admin can do anything.
2774         $this->assertTrue(\core_message\api::can_mark_all_messages_as_read($user1->id, $conversationid));
2776         // Set as the user 1.
2777         $this->setUser($user1);
2779         // The user can mark the messages as he is in the conversation.
2780         $this->assertTrue(\core_message\api::can_mark_all_messages_as_read($user1->id, $conversationid));
2782         // User 1 can not mark the messages read for user 2.
2783         $this->assertFalse(\core_message\api::can_mark_all_messages_as_read($user2->id, $conversationid));
2785         // This user is not a part of the conversation.
2786         $this->assertFalse(\core_message\api::can_mark_all_messages_as_read($user3->id, $conversationid));
2787     }
2789     /**
2790      * Tests checking if a user can delete a conversation.
2791      */
2792     public function test_can_delete_conversation() {
2793         // Set as the admin.
2794         $this->setAdminUser();
2796         // Create some users.
2797         $user1 = self::getDataGenerator()->create_user();
2798         $user2 = self::getDataGenerator()->create_user();
2800         // Send some messages back and forth.
2801         $time = 1;
2802         $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
2803         $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
2804         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
2805         $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
2807         $conversationid = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
2809         // The admin can do anything.
2810         $this->assertTrue(\core_message\api::can_delete_conversation($user1->id, $conversationid));
2812         // Set as the user 1.
2813         $this->setUser($user1);
2815         // They can delete their own messages.
2816         $this->assertTrue(\core_message\api::can_delete_conversation($user1->id, $conversationid));
2818         // They can't delete someone elses.
2819         $this->assertFalse(\core_message\api::can_delete_conversation($user2->id, $conversationid));
2820     }
2822     /**
2823      * Tests deleting a conversation.
2824      */
2825     public function test_delete_conversation() {
2826         global $DB;
2828         // Create some users.
2829         $user1 = self::getDataGenerator()->create_user();
2830         $user2 = self::getDataGenerator()->create_user();
2832         // The person doing the search.
2833         $this->setUser($user1);
2835         // Send some messages back and forth.
2836         $time = 1;
2837         $m1id = $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
2838         $m2id = $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
2839         $m3id = $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
2840         $m4id = $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
2842         // Delete the conversation as user 1.
2843         \core_message\api::delete_conversation($user1->id, $user2->id);
2844         $this->assertDebuggingCalled();
2846         $muas = $DB->get_records('message_user_actions', array(), 'timecreated ASC');
2847         $this->assertCount(4, $muas);
2848         // Sort by id.
2849         ksort($muas);
2851         $mua1 = array_shift($muas);
2852         $mua2 = array_shift($muas);
2853         $mua3 = array_shift($muas);
2854         $mua4 = array_shift($muas);
2856         $this->assertEquals($user1->id, $mua1->userid);
2857         $this->assertEquals($m1id, $mua1->messageid);
2858         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua1->action);
2860         $this->assertEquals($user1->id, $mua2->userid);
2861         $this->assertEquals($m2id, $mua2->messageid);
2862         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua2->action);
2864         $this->assertEquals($user1->id, $mua3->userid);
2865         $this->assertEquals($m3id, $mua3->messageid);
2866         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua3->action);
2868         $this->assertEquals($user1->id, $mua4->userid);
2869         $this->assertEquals($m4id, $mua4->messageid);
2870         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua4->action);
2871     }
2873     /**
2874      * Tests deleting a conversation by conversation id.
2875      */
2876     public function test_delete_conversation_by_id() {
2877         global $DB;
2879         // Create some users.
2880         $user1 = self::getDataGenerator()->create_user();
2881         $user2 = self::getDataGenerator()->create_user();
2883         // The person doing the search.
2884         $this->setUser($user1);
2886         // Send some messages back and forth.
2887         $time = 1;
2888         $m1id = $this->send_fake_message($user1, $user2, 'Yo!', 0, $time + 1);
2889         $m2id = $this->send_fake_message($user2, $user1, 'Sup mang?', 0, $time + 2);
2890         $m3id = $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!', 0, $time + 3);
2891         $m4id = $this->send_fake_message($user2, $user1, 'Word.', 0, $time + 4);
2893         // Delete the conversation as user 1.
2894         $conversationid = \core_message\api::get_conversation_between_users([$user1->id, $user2->id]);
2895         \core_message\api::delete_conversation_by_id($user1->id, $conversationid);
2897         $muas = $DB->get_records('message_user_actions', array(), 'timecreated ASC');
2898         $this->assertCount(4, $muas);
2899         // Sort by id.
2900         ksort($muas);
2902         $mua1 = array_shift($muas);
2903         $mua2 = array_shift($muas);
2904         $mua3 = array_shift($muas);
2905         $mua4 = array_shift($muas);
2907         $this->assertEquals($user1->id, $mua1->userid);
2908         $this->assertEquals($m1id, $mua1->messageid);
2909         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua1->action);
2911         $this->assertEquals($user1->id, $mua2->userid);
2912         $this->assertEquals($m2id, $mua2->messageid);
2913         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua2->action);
2915         $this->assertEquals($user1->id, $mua3->userid);
2916         $this->assertEquals($m3id, $mua3->messageid);
2917         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua3->action);
2919         $this->assertEquals($user1->id, $mua4->userid);
2920         $this->assertEquals($m4id, $mua4->messageid);
2921         $this->assertEquals(\core_message\api::MESSAGE_ACTION_DELETED, $mua4->action);
2922     }
2924     /**
2925      * Tests counting unread conversations.
2926      */
2927     public function test_count_unread_conversations() {
2928         $this->resetAfterTest(true);
2930         // Create some users.
2931         $user1 = self::getDataGenerator()->create_user();
2932         $user2 = self::getDataGenerator()->create_user();
2933         $user3 = self::getDataGenerator()->create_user();
2934         $user4 = self::getDataGenerator()->create_user();
2936         // The person wanting the conversation count.
2937         $this->setUser($user1);
2939         // Send some messages back and forth, have some different conversations with different users.
2940         $this->send_fake_message($user1, $user2, 'Yo!');
2941         $this->send_fake_message($user2, $user1, 'Sup mang?');
2942         $this->send_fake_message($user1, $user2, 'Writing PHPUnit tests!');
2943         $this->send_fake_message($user2, $user1, 'Word.');
2945         $this->send_fake_message($user1, $user3, 'Booyah');
2946         $this->send_fake_message($user3, $user1, 'Whaaat?');
2947         $this->send_fake_message($user1, $user3, 'Nothing.');
2948         $this->send_fake_message($user3, $user1, 'Cool.');
2950         $this->send_fake_message($user1, $user4, 'Hey mate, you see the new messaging UI in Moodle?');
2951         $this->send_fake_message($user4, $user1, 'Yah brah, it\'s pretty rad.');
2952         $this->send_fake_message($user1, $user4, 'Dope.');
2954         // Check the amount for the current user.
2955         $this->assertEquals(3, core_message\api::count_unread_conversations());
2957         // Check the amount for the second user.
2958         $this->assertEquals(1, core_message\api::count_unread_conversations($user2));
2959     }
2961     /**
2962      * Tests deleting a conversation.
2963      */
2964     public function test_get_all_message_preferences() {
2965         $user = self::getDataGenerator()->create_user();
2966         $this->setUser($user);
2968         // Set a couple of preferences to test.
2969         set_user_preference('message_provider_mod_assign_assign_notification_loggedin', 'popup', $user);
2970         set_user_preference('message_provider_mod_assign_assign_notification_loggedoff', 'email', $user);
2972         $processors = get_message_processors();
2973         $providers = message_get_providers_for_user($user->id);
2974         $prefs = \core_message\api::get_all_message_preferences($processors, $providers, $user);
2976         $this->assertEquals(1, $prefs->mod_assign_assign_notification_loggedin['popup']);
2977         $this->assertEquals(1, $prefs->mod_assign_assign_notification_loggedoff['email']);
2978     }
2980     /**
2981      * Tests the user can post a message.
2982      */
2983     public function test_can_post_message() {
2984         // Create some users.
2985         $user1 = self::getDataGenerator()->create_user();
2986         $user2 = self::getDataGenerator()->create_user();
2988         // Set as the first user.
2989         $this->setUser($user1);
2991         // With the default privacy setting, users can't message them.
2992         $this->assertFalse(\core_message\api::can_post_message($user2));
2994         // Enrol users to the same course.
2995         $course = $this->getDataGenerator()->create_course();
2996         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
2997         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
2998         // After enrolling users to the course, they should be able to message them with the default privacy setting.
2999         $this->assertTrue(\core_message\api::can_post_message($user2));
3000     }
3002     /**
3003      * Tests the user can't post a message without proper capability.
3004      */
3005     public function test_can_post_message_without_sendmessage_cap() {
3006         global $DB;
3008         // Create some users.
3009         $user1 = self::getDataGenerator()->create_user();
3010         $user2 = self::getDataGenerator()->create_user();
3012         // Set as the user 1.
3013         $this->setUser($user1);
3015         // Remove the capability to send a message.
3016         $roleids = $DB->get_records_menu('role', null, '', 'shortname, id');
3017         unassign_capability('moodle/site:sendmessage', $roleids['user'],
3018             context_system::instance());
3020         // Check that we can not post a message without the capability.
3021         $this->assertFalse(\core_message\api::can_post_message($user2));
3022     }
3024     /**
3025      * Tests the user can post a message when they are contact.
3026      */
3027     public function test_can_post_message_when_contact() {
3028         // Create some users.
3029         $user1 = self::getDataGenerator()->create_user();
3030         $user2 = self::getDataGenerator()->create_user();
3032         // Set as the first user.
3033         $this->setUser($user1);
3035         // Check that we can not send user2 a message.
3036         $this->assertFalse(\core_message\api::can_post_message($user2));
3038         // Add users as contacts.
3039         \core_message\api::add_contact($user1->id, $user2->id);
3041         // Check that the return result is now true.
3042         $this->assertTrue(\core_message\api::can_post_message($user2));
3043     }
3045     /**
3046      * Tests the user can't post a message if they are not a contact and the user
3047      * has requested messages only from contacts.
3048      */
3049     public function test_can_post_message_when_not_contact() {
3050         // Create some users.
3051         $user1 = self::getDataGenerator()->create_user();
3052         $user2 = self::getDataGenerator()->create_user();
3054         // Set as the first user.
3055         $this->setUser($user1);
3057         // Set the second user's preference to not receive messages from non-contacts.
3058         set_user_preference('message_blocknoncontacts', \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS, $user2->id);
3060         // Check that we can not send user 2 a message.
3061         $this->assertFalse(\core_message\api::can_post_message($user2));
3062     }
3064     /**
3065      * Tests the user can't post a message if they are blocked.
3066      */
3067     public function test_can_post_message_when_blocked() {
3068         // Create some users.
3069         $user1 = self::getDataGenerator()->create_user();
3070         $user2 = self::getDataGenerator()->create_user();
3072         // Set the user.
3073         $this->setUser($user1);
3075         // Block the second user.
3076         \core_message\api::block_user($user1->id, $user2->id);
3078         // Check that the second user can no longer send the first user a message.
3079         $this->assertFalse(\core_message\api::can_post_message($user1, $user2));
3080     }
3082     /**
3083      * Tests the user can post a message when site-wide messaging setting is enabled,
3084      * even if they are not a contact and are not members of the same course.
3085      */
3086     public function test_can_post_message_site_messaging_setting() {
3087         // Create some users.
3088         $user1 = self::getDataGenerator()->create_user();
3089         $user2 = self::getDataGenerator()->create_user();
3091         // Set as the first user.
3092         $this->setUser($user1);
3094         // By default, user only can be messaged by contacts and members of any of his/her courses.
3095         $this->assertFalse(\core_message\api::can_post_message($user2));
3097         // Enable site-wide messagging privacy setting. The user will be able to receive messages from everybody.
3098         set_config('messagingallusers', true);
3100         // Set the second user's preference to receive messages from everybody.
3101         set_user_preference('message_blocknoncontacts', \core_message\api::MESSAGE_PRIVACY_SITE, $user2->id);
3103         // Check that we can send user2 a message.
3104         $this->assertTrue(\core_message\api::can_post_message($user2));
3106         // Disable site-wide messagging privacy setting. The user will be able to receive messages from contacts
3107         // and members sharing a course with her.
3108         set_config('messagingallusers', false);
3110         // As site-wide messaging setting is disabled, the value for user2 will be changed to MESSAGE_PRIVACY_COURSEMEMBER.
3111         $this->assertFalse(\core_message\api::can_post_message($user2));
3113         // Enrol users to the same course.
3114         $course = $this->getDataGenerator()->create_course();
3115         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
3116         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
3117         // Check that we can send user2 a message because they are sharing a course.
3118         $this->assertTrue(\core_message\api::can_post_message($user2));
3120         // Set the second user's preference to receive messages only from contacts.
3121         set_user_preference('message_blocknoncontacts', \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS, $user2->id);
3122         // Check that now the user2 can't be contacted because user1 is not their contact.
3123         $this->assertFalse(\core_message\api::can_post_message($user2));
3125         // Make contacts user1 and user2.
3126         \core_message\api::add_contact($user2->id, $user1->id);
3127         // Check that we can send user2 a message because they are contacts.
3128         $this->assertTrue(\core_message\api::can_post_message($user2));
3129     }
3131     /**
3132      * Tests the user with the messageanyuser capability can post a message.
3133      */
3134     public function test_can_post_message_with_messageanyuser_cap() {
3135         global $DB;
3137         // Create some users.
3138         $teacher1 = self::getDataGenerator()->create_user();
3139         $student1 = self::getDataGenerator()->create_user();
3140         $student2 = self::getDataGenerator()->create_user();
3142         // Create users not enrolled in any course.
3143         $user1 = self::getDataGenerator()->create_user();
3145         // Create a course.
3146         $course1 = $this->getDataGenerator()->create_course();
3148         // Enrol the users in the course.
3149         $this->getDataGenerator()->enrol_user($teacher1->id, $course1->id, 'editingteacher');
3150         $this->getDataGenerator()->enrol_user($student1->id, $course1->id, 'student');
3151         $this->getDataGenerator()->enrol_user($student2->id, $course1->id, 'student');
3153         // Set some student preferences to not receive messages from non-contacts.
3154         set_user_preference('message_blocknoncontacts', \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS, $student1->id);
3156         // Check that we can send student1 a message because teacher has the messageanyuser cap by default.
3157         $this->assertTrue(\core_message\api::can_post_message($student1, $teacher1));
3158         // Check that the teacher can't contact user1 because it's not his teacher.
3159         $this->assertFalse(\core_message\api::can_post_message($user1, $teacher1));
3161         // Remove the messageanyuser capability from the course1 for teachers.
3162         $coursecontext = context_course::instance($course1->id);
3163         $teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher']);
3164         assign_capability('moodle/site:messageanyuser', CAP_PROHIBIT, $teacherrole->id, $coursecontext->id);
3165         $coursecontext->mark_dirty();
3167         // Check that we can't send user1 a message because they are not contacts.
3168         $this->assertFalse(\core_message\api::can_post_message($student1, $teacher1));
3169         // However, teacher can message student2 because they are sharing a course.
3170         $this->assertTrue(\core_message\api::can_post_message($student2, $teacher1));
3171     }
3173     /**
3174      * Verify the expected behaviour of the can_send_message_to_conversation() method for authenticated users with default settings.
3175      */
3176     public function test_can_send_message_to_conversation_basic() {
3177         // Create some users.
3178         $user1 = self::getDataGenerator()->create_user();
3179         $user2 = self::getDataGenerator()->create_user();
3180         $user3 = self::getDataGenerator()->create_user();
3182         // Create an individual conversation between user1 and user2.
3183         $ic1 = \core_message\api::create_conversation(
3184             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
3185             [
3186                 $user1->id,
3187                 $user2->id
3188             ]
3189         );
3191         // Create a group conversation between and users 1, 2 and 3.
3192         $gc1 = \core_message\api::create_conversation(
3193             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
3194             [
3195                 $user1->id,
3196                 $user2->id,
3197                 $user3->id
3198             ]
3199         );
3201         // For group conversations, there are no user privacy checks, so only membership in the conversation is needed.
3202         $this->assertTrue(\core_message\api::can_send_message_to_conversation($user1->id, $gc1->id));
3204         // For individual conversations, the default privacy setting of 'only contacts and course members' applies.
3205         // Users are not in the same course, nor are they contacts, so messages cannot be sent.
3206         $this->assertFalse(\core_message\api::can_send_message_to_conversation($user1->id, $ic1->id));
3208         // Enrol the users into the same course.
3209         $course = $this->getDataGenerator()->create_course();
3210         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
3211         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
3213         // After enrolling users to the course, they should be able to message them with the default privacy setting.
3214         $this->assertTrue(\core_message\api::can_send_message_to_conversation($user1->id, $ic1->id));
3215     }
3217     /**
3218      * Verify the behaviour of can_send_message_to_conversation() for authenticated users without the sendmessage capability.
3219      */
3220     public function test_can_send_message_to_conversation_sendmessage_cap() {
3221         global $DB;
3223         $user1 = self::getDataGenerator()->create_user();
3224         $user2 = self::getDataGenerator()->create_user();
3225         $user3 = self::getDataGenerator()->create_user();
3227         // Enrol the users into the same course.
3228         $course = $this->getDataGenerator()->create_course();
3229         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
3230         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
3231         $this->getDataGenerator()->enrol_user($user3->id, $course->id);
3233         // Create an individual conversation between user1 and user2.
3234         $ic1 = \core_message\api::create_conversation(
3235             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
3236             [
3237                 $user1->id,
3238                 $user2->id
3239             ]
3240         );
3242         // Group conversation between and users 1, 2 and 3.
3243         $gc1 = \core_message\api::create_conversation(
3244             \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP,
3245             [
3246                 $user1->id,
3247                 $user2->id,
3248                 $user3->id
3249             ]
3250         );
3252         // Default settings - user1 can send a message to both conversations.
3253         $this->assertTrue(\core_message\api::can_send_message_to_conversation($user1->id, $ic1->id));
3254         $this->assertTrue(\core_message\api::can_send_message_to_conversation($user1->id, $gc1->id));
3256         // Remove the capability to send a message.
3257         $roleids = $DB->get_records_menu('role', null, '', 'shortname, id');
3258         unassign_capability('moodle/site:sendmessage', $roleids['user'], context_system::instance());
3260         // Verify that a user cannot send a message to either an individual or a group conversation.
3261         $this->assertFalse(\core_message\api::can_send_message_to_conversation($user1->id, $ic1->id));
3262         $this->assertFalse(\core_message\api::can_send_message_to_conversation($user1->id, $gc1->id));
3263     }
3265     /**
3266      * Verify the behaviour of can_send_message_to_conversation() for authenticated users without the messageanyuser capability.
3267      */
3268     public function test_can_send_message_to_conversation_messageanyuser_cap() {
3269         global $DB;
3271         $user1 = self::getDataGenerator()->create_user();
3272         $user2 = self::getDataGenerator()->create_user();
3273         $user3 = self::getDataGenerator()->create_user();
3275         // Enrol the users into the same course.
3276         $course = $this->getDataGenerator()->create_course();
3277         $this->getDataGenerator()->enrol_user($user1->id, $course->id);
3278         $this->getDataGenerator()->enrol_user($user2->id, $course->id);
3279         $this->getDataGenerator()->enrol_user($user3->id, $course->id);
3281         // Create an individual conversation between user1 and user2.
3282         $ic1 = \core_message\api::create_conversation(
3283             \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
3284             [
3285                 $user1->id,
3286                 $user2->id
3287             ]
3288         );