Matt Porritt
e396e62df5
Make indexing of user messages tolerant to user deletion. When creating the search document for user messages, add a check to see if the user has been deleted in the system. If they have been deleted abort creating the search document. This is to avoid rasining an error when trying to get the user context for a deleted user.
275 lines
9.5 KiB
PHP
275 lines
9.5 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Sent message global search unit tests.
|
|
*
|
|
* @package core
|
|
* @copyright 2016 Devang Gaur
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/search/tests/fixtures/testable_core_search.php');
|
|
|
|
/**
|
|
* Provides the unit tests for sent message global search.
|
|
*
|
|
* @package core
|
|
* @copyright 2016 Devang Gaur
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class message_sent_search_testcase extends advanced_testcase {
|
|
|
|
/**
|
|
* @var string Area id
|
|
*/
|
|
protected $messagesentareaid = null;
|
|
|
|
/**
|
|
* Setting up the test environment
|
|
* @return void
|
|
*/
|
|
public function setUp() {
|
|
$this->resetAfterTest(true);
|
|
set_config('enableglobalsearch', true);
|
|
|
|
$this->messagesentareaid = \core_search\manager::generate_areaid('core_message', 'message_sent');
|
|
|
|
// Set \core_search::instance to the mock_search_engine as we don't require the search engine to be working to test this.
|
|
$search = testable_core_search::instance();
|
|
}
|
|
|
|
/**
|
|
* Indexing messages contents.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_message_sent_indexing() {
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->messagesentareaid);
|
|
$this->assertInstanceOf('\core_message\search\message_sent', $searcharea);
|
|
|
|
$user1 = self::getDataGenerator()->create_user();
|
|
$user2 = self::getDataGenerator()->create_user();
|
|
|
|
$this->preventResetByRollback();
|
|
$sink = $this->redirectMessages();
|
|
|
|
$message = new \core\message\message();
|
|
$message->courseid = SITEID;
|
|
$message->userfrom = $user1;
|
|
$message->userto = $user2;
|
|
$message->subject = "Test Subject";
|
|
$message->smallmessage = "Test small messsage";
|
|
$message->fullmessage = "Test full messsage";
|
|
$message->fullmessageformat = 0;
|
|
$message->fullmessagehtml = null;
|
|
$message->notification = 0;
|
|
$message->component = 'moodle';
|
|
$message->name = "instantmessage";
|
|
|
|
message_send($message);
|
|
|
|
$messages = $sink->get_messages();
|
|
|
|
$this->assertEquals(1, count($messages));
|
|
|
|
// All records.
|
|
$recordset = $searcharea->get_recordset_by_timestamp(0);
|
|
$this->assertTrue($recordset->valid());
|
|
$nrecords = 0;
|
|
foreach ($recordset as $record) {
|
|
$this->assertInstanceOf('stdClass', $record);
|
|
$doc = $searcharea->get_document($record);
|
|
$this->assertInstanceOf('\core_search\document', $doc);
|
|
$nrecords++;
|
|
}
|
|
// If there would be an error/failure in the foreach above the recordset would be closed on shutdown.
|
|
$recordset->close();
|
|
$this->assertEquals(1, $nrecords);
|
|
|
|
// The +2 is to prevent race conditions.
|
|
$recordset = $searcharea->get_recordset_by_timestamp(time() + 2);
|
|
|
|
// No new records.
|
|
$this->assertFalse($recordset->valid());
|
|
$recordset->close();
|
|
}
|
|
|
|
/**
|
|
* Document contents.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_message_sent_document() {
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->messagesentareaid);
|
|
$this->assertInstanceOf('\core_message\search\message_sent', $searcharea);
|
|
|
|
$user1 = self::getDataGenerator()->create_user();
|
|
$user2 = self::getDataGenerator()->create_user();
|
|
|
|
$this->preventResetByRollback();
|
|
$sink = $this->redirectMessages();
|
|
|
|
$message = new \core\message\message();
|
|
$message->courseid = SITEID;
|
|
$message->userfrom = $user1;
|
|
$message->userto = $user2;
|
|
$message->subject = "Test Subject";
|
|
$message->smallmessage = "Test small messsage";
|
|
$message->fullmessage = "Test full messsage";
|
|
$message->fullmessageformat = 0;
|
|
$message->fullmessagehtml = null;
|
|
$message->notification = 0;
|
|
$message->component = "moodle";
|
|
$message->name = "instantmessage";
|
|
|
|
message_send($message);
|
|
|
|
$messages = $sink->get_messages();
|
|
$message = $messages[0];
|
|
|
|
$doc = $searcharea->get_document($message);
|
|
$this->assertInstanceOf('\core_search\document', $doc);
|
|
$this->assertEquals($message->id, $doc->get('itemid'));
|
|
$this->assertEquals($this->messagesentareaid . '-' . $message->id, $doc->get('id'));
|
|
$this->assertEquals(SITEID, $doc->get('courseid'));
|
|
$this->assertEquals($message->useridfrom, $doc->get('owneruserid'));
|
|
$this->assertEquals($message->useridto, $doc->get('userid'));
|
|
$this->assertEquals(content_to_text($message->subject, false), $doc->get('title'));
|
|
$this->assertEquals(content_to_text($message->smallmessage, false), $doc->get('content'));
|
|
}
|
|
|
|
/**
|
|
* Document accesses.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_message_sent_access() {
|
|
global $CFG;
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->messagesentareaid);
|
|
|
|
$user1 = self::getDataGenerator()->create_user();
|
|
$user2 = self::getDataGenerator()->create_user();
|
|
$user3 = self::getDataGenerator()->create_user();
|
|
|
|
$this->preventResetByRollback();
|
|
$sink = $this->redirectMessages();
|
|
|
|
$message = new \core\message\message();
|
|
$message->courseid = SITEID;
|
|
$message->userfrom = $user1;
|
|
$message->userto = $user2;
|
|
$message->subject = "Test Subject";
|
|
$message->smallmessage = "Test small messsage";
|
|
$message->fullmessage = "Test full messsage";
|
|
$message->fullmessageformat = 0;
|
|
$message->fullmessagehtml = null;
|
|
$message->notification = 0;
|
|
$message->component = "moodle";
|
|
$message->name = "instantmessage";
|
|
|
|
$messageid = message_send($message);
|
|
|
|
$messages = $sink->get_messages();
|
|
$message = $messages[0];
|
|
|
|
$this->setUser($user1);
|
|
|
|
if ($CFG->messaging) {
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($messageid));
|
|
} else {
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($messageid));
|
|
}
|
|
|
|
$this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-123));
|
|
|
|
message_delete_message($message, $user1->id);
|
|
$this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access($messageid));
|
|
|
|
$this->setUser($user2);
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($messageid));
|
|
|
|
$this->setUser($user3);
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($messageid));
|
|
|
|
$this->setGuestUser();
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($messageid));
|
|
|
|
$this->setAdminUser();
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($messageid));
|
|
|
|
delete_user($user2);
|
|
|
|
$this->setUser($user1);
|
|
$this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access($messageid));
|
|
|
|
}
|
|
|
|
/**
|
|
* Test sent deleted user.
|
|
* Tests the case where a sent message for a deleted user
|
|
* is attempted to be added to the index.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_message_sent_deleted_user() {
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->messagesentareaid);
|
|
$this->assertInstanceOf('\core_message\search\message_sent', $searcharea);
|
|
|
|
$user1 = self::getDataGenerator()->create_user();
|
|
$user2 = self::getDataGenerator()->create_user();
|
|
|
|
$this->preventResetByRollback();
|
|
$sink = $this->redirectMessages();
|
|
|
|
$message = new \core\message\message();
|
|
$message->courseid = SITEID;
|
|
$message->userfrom = $user1;
|
|
$message->userto = $user2;
|
|
$message->subject = "Test Subject";
|
|
$message->smallmessage = "Test small messsage";
|
|
$message->fullmessage = "Test full messsage";
|
|
$message->fullmessageformat = 0;
|
|
$message->fullmessagehtml = null;
|
|
$message->notification = 0;
|
|
$message->component = "moodle";
|
|
$message->name = "instantmessage";
|
|
|
|
message_send($message);
|
|
|
|
$messages = $sink->get_messages();
|
|
$message = $messages[0];
|
|
|
|
// Delete user.
|
|
delete_user($user1);
|
|
|
|
$doc = $searcharea->get_document($message);
|
|
|
|
$this->assertFalse($doc);
|
|
|
|
}
|
|
} |