mirror of
https://github.com/moodle/moodle.git
synced 2025-03-15 21:20:02 +01:00
66e3702680
This change considers all existing search areas in Moodle and makes necessary changes. Custom change to course search, supported by helper in base.php: * course/classes/search/mycourse.php Custom change to message search: * message/classes/search/message_received.php * message/classes/search/message_sent.php Custom change to user search: * user/classes/search/user.php Custom changes to module areas, supported by helper in base_mod.php: * mod/book/classes/search/chapter.php * mod/data/classes/search/entry.php * mod/forum/classes/search/post.php * mod/glossary/classes/search/entry.php * mod/survey/classes/search/activity.php * mod/wiki/classes/search/collaborative_page.php (Note: the unit tests do not exhaustively check every context type for these, given that's mainly handled by the helper function which was already tested in the base_activity test.) Handled by block base class (no change): * blocks/html/classes/search/content.php Handled by activity base class (no change): * mod/assign/classes/search/activity.php * mod/book/classes/search/activity.php * mod/chat/classes/search/activity.php * mod/choice/classes/search/activity.php * mod/data/classes/search/activity.php * mod/feedback/classes/search/activity.php * mod/folder/classes/search/activity.php * mod/forum/classes/search/activity.php * mod/glossary/classes/search/activity.php * mod/imscp/classes/search/activity.php * mod/label/classes/search/activity.php * mod/lesson/classes/search/activity.php * mod/lti/classes/search/activity.php * mod/page/classes/search/activity.php * mod/quiz/classes/search/activity.php * mod/resource/classes/search/activity.php * mod/scorm/classes/search/activity.php * mod/url/classes/search/activity.php * mod/wiki/classes/search/activity.php * mod/workshop/classes/search/activity.php
219 lines
11 KiB
PHP
219 lines
11 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/>.
|
|
|
|
/**
|
|
* Course global search unit tests.
|
|
*
|
|
* @package core
|
|
* @copyright 2016 Devang Gaur {@link http://www.devanggaur.com}
|
|
* @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 course global search.
|
|
*
|
|
* @package core
|
|
* @copyright 2016 Devang Gaur {@link http://www.davidmonllao.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class user_search_testcase extends advanced_testcase {
|
|
|
|
/**
|
|
* @var string Area id
|
|
*/
|
|
protected $userareaid = null;
|
|
|
|
public function setUp() {
|
|
$this->resetAfterTest(true);
|
|
set_config('enableglobalsearch', true);
|
|
|
|
$this->userareaid = \core_search\manager::generate_areaid('core_user', 'user');
|
|
|
|
// 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 users contents.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_users_indexing() {
|
|
global $SITE;
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->userareaid);
|
|
$this->assertInstanceOf('\core_user\search\user', $searcharea);
|
|
|
|
$user1 = self::getDataGenerator()->create_user();
|
|
$user2 = self::getDataGenerator()->create_user();
|
|
|
|
// All records.
|
|
// Recordset will produce 4 user records:
|
|
// Guest User, Admin User and two above generated users.
|
|
$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(4, $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();
|
|
|
|
// Context support; first, try an unsupported context type.
|
|
$coursecontext = context_course::instance($SITE->id);
|
|
$this->assertNull($searcharea->get_document_recordset(0, $coursecontext));
|
|
|
|
// Try a specific user, will only return 1 record (that user).
|
|
$rs = $searcharea->get_document_recordset(0, context_user::instance($user1->id));
|
|
$this->assertEquals(1, iterator_count($rs));
|
|
$rs->close();
|
|
}
|
|
|
|
/**
|
|
* Document contents.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_users_document() {
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->userareaid);
|
|
$this->assertInstanceOf('\core_user\search\user', $searcharea);
|
|
|
|
$user = self::getDataGenerator()->create_user();
|
|
|
|
$doc = $searcharea->get_document($user);
|
|
$this->assertInstanceOf('\core_search\document', $doc);
|
|
$this->assertEquals($user->id, $doc->get('itemid'));
|
|
$this->assertEquals($this->userareaid . '-' . $user->id, $doc->get('id'));
|
|
$this->assertEquals(SITEID, $doc->get('courseid'));
|
|
$this->assertFalse($doc->is_set('userid'));
|
|
$this->assertEquals(\core_search\manager::NO_OWNER_ID, $doc->get('owneruserid'));
|
|
$this->assertEquals(content_to_text(fullname($user), false), $doc->get('title'));
|
|
$this->assertEquals(content_to_text($user->description, $user->descriptionformat), $doc->get('content'));
|
|
}
|
|
|
|
/**
|
|
* Document accesses.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function test_users_access() {
|
|
global $CFG;
|
|
|
|
// Returns the instance as long as the area is supported.
|
|
$searcharea = \core_search\manager::get_search_area($this->userareaid);
|
|
|
|
$user1 = self::getDataGenerator()->create_user();
|
|
$user2 = self::getDataGenerator()->create_user();
|
|
$user3 = self::getDataGenerator()->create_user();
|
|
$user4 = self::getDataGenerator()->create_user();
|
|
$user5 = self::getDataGenerator()->create_user();
|
|
$user5->id = 0; // Visitor (not guest).
|
|
|
|
$deleteduser = self::getDataGenerator()->create_user(array('deleted' => 1));
|
|
$unconfirmeduser = self::getDataGenerator()->create_user(array('confirmed' => 0));
|
|
$suspendeduser = self::getDataGenerator()->create_user(array('suspended' => 1));
|
|
|
|
$course1 = self::getDataGenerator()->create_course();
|
|
$course2 = self::getDataGenerator()->create_course();
|
|
|
|
$group1 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id));
|
|
$group2 = $this->getDataGenerator()->create_group(array('courseid' => $course1->id));
|
|
|
|
$this->getDataGenerator()->enrol_user($user1->id, $course1->id, 'teacher');
|
|
$this->getDataGenerator()->enrol_user($user2->id, $course1->id, 'student');
|
|
$this->getDataGenerator()->enrol_user($user2->id, $course2->id, 'student');
|
|
$this->getDataGenerator()->enrol_user($user3->id, $course2->id, 'student');
|
|
$this->getDataGenerator()->enrol_user($user4->id, $course2->id, 'student');
|
|
$this->getDataGenerator()->enrol_user($suspendeduser->id, $course1->id, 'student');
|
|
|
|
$this->getDataGenerator()->create_group_member(array('userid' => $user2->id, 'groupid' => $group1->id));
|
|
$this->getDataGenerator()->create_group_member(array('userid' => $user3->id, 'groupid' => $group1->id));
|
|
$this->getDataGenerator()->create_group_member(array('userid' => $user4->id, 'groupid' => $group2->id));
|
|
|
|
$this->setAdminUser();
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access($deleteduser->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($unconfirmeduser->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($suspendeduser->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access(2));
|
|
|
|
$this->setUser($user1);
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user3->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user4->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access(1));// Guest user can't be accessed.
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access(2));// Admin user can't be accessed.
|
|
$this->assertEquals(\core_search\manager::ACCESS_DELETED, $searcharea->check_access(-123));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($unconfirmeduser->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($suspendeduser->id));
|
|
|
|
$this->setUser($user2);
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user4->id));
|
|
|
|
$this->setUser($user3);
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($suspendeduser->id));
|
|
|
|
$this->setGuestUser();
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user3->id));
|
|
|
|
$CFG->forceloginforprofiles = 0;
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
|
|
|
|
$this->setUser($user5);
|
|
$CFG->forceloginforprofiles = 1;
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($user3->id));
|
|
|
|
$CFG->forceloginforprofiles = 0;
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user1->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user2->id));
|
|
$this->assertEquals(\core_search\manager::ACCESS_GRANTED, $searcharea->check_access($user3->id));
|
|
}
|
|
}
|