L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-61256 core_search: Support search of section titles, summaries

Browse Source
This commit is contained in:
sam marshall
2018-03-29 17:38:36 +01:00
parent 39fab18e27
commit 40aa5fe9ab
3 changed files with 399 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
course/classes/search/section.php
+192
View File
@@ -0,0 +1,192 @@
<?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/>.
/**
* Search area for course sections (title and summary).
*
* @package core_course
* @copyright 2018 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_course\search;
defined('MOODLE_INTERNAL') || die();
/**
* Search area for course sections (title and summary).
*
* Note this does not include the activities within the section, as these have their own search
* areas.
*
* @package core_course
* @copyright 2018 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class section extends \core_search\base {
/**
* Sections are indexed at course context.
*
* @var array
*/
protected static $levels = [CONTEXT_COURSE];
/**
* Returns recordset containing required data for indexing course sections.
*
* @param int $modifiedfrom timestamp
* @param \context|null $context Restriction context
* @return \moodle_recordset|null Recordset or null if no change possible
*/
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
list ($contextjoin, $contextparams) = $this->get_course_level_context_restriction_sql(
$context, 'c');
if ($contextjoin === null) {
return null;
}
$comparetext = $DB->sql_compare_text('cs.summary', 1);
return $DB->get_recordset_sql("
SELECT cs.id, cs.course, cs.section, cs.name, cs.summary, cs.summaryformat,
cs.timemodified
FROM {course_sections} cs
JOIN {course} c ON c.id = cs.course
$contextjoin
WHERE cs.timemodified >= ?
AND (cs.name != ? OR $comparetext != ?)
ORDER BY cs.timemodified ASC", array_merge($contextparams, [$modifiedfrom, '', '']));
}
/**
* Returns the document associated with this section.
*
* @param \stdClass $record
* @param array $options
* @return \core_search\document
*/
public function get_document($record, $options = array()) {
// Get the context, modinfo, and section.
try {
$context = \context_course::instance($record->course);
} catch (\moodle_exception $ex) {
// Notify it as we run here as admin, we should see everything.
debugging('Error retrieving ' . $this->areaid . ' ' . $record->id .
' document, not all required data is available: ' . $ex->getMessage(),
DEBUG_DEVELOPER);
return false;
}
// Title - use default if none given.
$title = get_section_name($record->course, $record->section);
// Prepare associative array with data from DB.
$doc = \core_search\document_factory::instance($record->id, $this->componentname, $this->areaname);
$doc->set('title', content_to_text($title, false));
$doc->set('content', content_to_text($record->summary, $record->summaryformat));
$doc->set('contextid', $context->id);
$doc->set('courseid', $record->course);
$doc->set('owneruserid', \core_search\manager::NO_OWNER_ID);
$doc->set('modified', $record->timemodified);
return $doc;
}
/**
* Whether the user can access the section or not.
*
* @param int $id The course section id.
* @return int One of the \core_search\manager:ACCESS_xx constants
*/
public function check_access($id) {
global $DB;
// Check we can get the section and the course modinfo.
$sectionrec = $DB->get_record('course_sections', ['id' => $id], '*', IGNORE_MISSING);
if (!$sectionrec) {
return \core_search\manager::ACCESS_DELETED;
}
try {
$modinfo = get_fast_modinfo($sectionrec->course);
} catch (\moodle_exception $e) {
return \core_search\manager::ACCESS_DELETED;
}
$section = $modinfo->get_section_info($sectionrec->section, IGNORE_MISSING);
if (!$section) {
return \core_search\manager::ACCESS_DELETED;
}
// Check access to course and that the section is visible to current user.
if (can_access_course($modinfo->get_course()) && $section->uservisible) {
return \core_search\manager::ACCESS_GRANTED;
}
return \core_search\manager::ACCESS_DENIED;
}
/**
* Gets a link to the section.
*
* @param \core_search\document $doc
* @return \moodle_url
*/
public function get_doc_url(\core_search\document $doc) {
global $DB;
$section = $DB->get_field('course_sections', 'section',
['id' => $doc->get('itemid')], MUST_EXIST);
$format = course_get_format($doc->get('courseid'));
return $format->get_view_url($section);
}
/**
* Gets a link to the section.
*
* @param \core_search\document $doc
* @return \moodle_url
*/
public function get_context_url(\core_search\document $doc) {
return $this->get_doc_url($doc);
}
/**
* Returns true to include summary files in the index.
*
* @return bool True
*/
public function uses_file_indexing() {
return true;
}
/**
* Return the file area that is used for summary files.
*
* @return array File area name
*/
public function get_search_fileareas() {
return ['section'];
}
/**
* Returns the moodle component name, as used in the files table.
*
* @return string Component name
*/
public function get_component_name() {
return 'course';
}
}
course/tests/search_test.php
+206
View File
@@ -43,11 +43,17 @@ class course_search_testcase extends advanced_testcase {
*/
protected $mycoursesareaid = null;
/**
* @var string Area id for sections
*/
protected $sectionareaid = null;
public function setUp() {
$this->resetAfterTest(true);
set_config('enableglobalsearch', true);
$this->mycoursesareaid = \core_search\manager::generate_areaid('core_course', 'mycourse');
$this->sectionareaid = \core_search\manager::generate_areaid('core_course', 'section');
// 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();
@@ -240,4 +246,204 @@ class course_search_testcase extends advanced_testcase {
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($course2->id));
$this->assertEquals(\core_search\manager::ACCESS_DENIED, $searcharea->check_access($course3->id));
}
/**
* Indexing section contents.
*/
public function test_section_indexing() {
global $DB, $USER;
// Returns the instance as long as the area is supported.
$searcharea = \core_search\manager::get_search_area($this->sectionareaid);
$this->assertInstanceOf('\core_course\search\section', $searcharea);
// Create some courses in categories, and a forum.
$generator = $this->getDataGenerator();
$cat1 = $generator->create_category();
$cat2 = $generator->create_category(['parent' => $cat1->id]);
$course1 = $generator->create_course(['category' => $cat1->id]);
$course2 = $generator->create_course(['category' => $cat2->id]);
$forum = $generator->create_module('forum', ['course' => $course1->id]);
// Edit 2 sections on course 1 and one on course 2.
$existing = $DB->get_record('course_sections', ['course' => $course1->id, 'section' => 2]);
$course1section2id = $existing->id;
$new = clone($existing);
$new->name = 'Frogs';
course_update_section($course1->id, $existing, $new);
$existing = $DB->get_record('course_sections', ['course' => $course1->id, 'section' => 3]);
$course1section3id = $existing->id;
$new = clone($existing);
$new->summary = 'Frogs';
$new->summaryformat = FORMAT_HTML;
course_update_section($course1->id, $existing, $new);
$existing = $DB->get_record('course_sections', ['course' => $course2->id, 'section' => 1]);
$course2section1id = $existing->id;
$new = clone($existing);
$new->summary = 'Frogs';
$new->summaryformat = FORMAT_HTML;
course_update_section($course2->id, $existing, $new);
// Bodge timemodified into a particular order.
$DB->set_field('course_sections', 'timemodified', 1, ['id' => $course1section3id]);
$DB->set_field('course_sections', 'timemodified', 2, ['id' => $course1section2id]);
$DB->set_field('course_sections', 'timemodified', 3, ['id' => $course2section1id]);
// All records.
$results = self::recordset_to_ids($searcharea->get_document_recordset(0));
$this->assertEquals([$course1section3id, $course1section2id, $course2section1id], $results);
// Records after time 2.
$results = self::recordset_to_ids($searcharea->get_document_recordset(2));
$this->assertEquals([$course1section2id, $course2section1id], $results);
// Records after time 10 (there aren't any).
$results = self::recordset_to_ids($searcharea->get_document_recordset(10));
$this->assertEquals([], $results);
// Find the first block to use for a block context.
$blockid = array_values($DB->get_records('block_instances', null, 'id', 'id', 0, 1))[0]->id;
$blockcontext = context_block::instance($blockid);
// Check with block context - should be null.
$this->assertNull($searcharea->get_document_recordset(0, $blockcontext));
// Check with user context - should be null.
$this->setAdminUser();
$usercontext = context_user::instance($USER->id);
$this->assertNull($searcharea->get_document_recordset(0, $usercontext));
// Check with module context - should be null.
$modcontext = context_module::instance($forum->cmid);
$this->assertNull($searcharea->get_document_recordset(0, $modcontext));
// Check with course context - should return specific course entries.
$coursecontext = context_course::instance($course1->id);
$results = self::recordset_to_ids($searcharea->get_document_recordset(0, $coursecontext));
$this->assertEquals([$course1section3id, $course1section2id], $results);
$results = self::recordset_to_ids($searcharea->get_document_recordset(2, $coursecontext));
$this->assertEquals([$course1section2id], $results);
// Check with category context - should return course in categories and subcategories.
$catcontext = context_coursecat::instance($cat1->id);
$results = self::recordset_to_ids($searcharea->get_document_recordset(0, $catcontext));
$this->assertEquals([$course1section3id, $course1section2id, $course2section1id], $results);
$catcontext = context_coursecat::instance($cat2->id);
$results = self::recordset_to_ids($searcharea->get_document_recordset(0, $catcontext));
$this->assertEquals([$course2section1id], $results);
// Check with system context - should return everything (same as null, tested first).
$systemcontext = context_system::instance();
$results = self::recordset_to_ids($searcharea->get_document_recordset(0, $systemcontext));
$this->assertEquals([$course1section3id, $course1section2id, $course2section1id], $results);
}
/**
* Document contents for sections.
*/
public function test_section_document() {
global $DB;
$searcharea = \core_search\manager::get_search_area($this->sectionareaid);
// Create a course.
$generator = $this->getDataGenerator();
$course = $generator->create_course();
// Test with default title.
$sectionrec = (object)['id' => 123, 'course' => $course->id,
'section' => 3, 'timemodified' => 456,
'summary' => 'Kermit', 'summaryformat' => FORMAT_HTML];
$doc = $searcharea->get_document($sectionrec);
$this->assertInstanceOf('\core_search\document', $doc);
$this->assertEquals(123, $doc->get('itemid'));
$this->assertEquals($this->sectionareaid . '-123', $doc->get('id'));
$this->assertEquals($course->id, $doc->get('courseid'));
$this->assertFalse($doc->is_set('userid'));
$this->assertEquals(\core_search\manager::NO_OWNER_ID, $doc->get('owneruserid'));
$this->assertEquals('Topic 3', $doc->get('title'));
$this->assertEquals('Kermit', $doc->get('content'));
// Test with user-set title.
$DB->set_field('course_sections', 'name', 'Frogs',
['course' => $course->id, 'section' => 3]);
rebuild_course_cache($course->id, true);
$doc = $searcharea->get_document($sectionrec);
$this->assertEquals('Frogs', $doc->get('title'));
}
/**
* Document access for sections.
*/
public function test_section_access() {
global $DB;
$searcharea = \core_search\manager::get_search_area($this->sectionareaid);
// Create a course.
$generator = $this->getDataGenerator();
$course = $generator->create_course();
// Create 2 users - student and manager. Initially, student is not even enrolled.
$student = $generator->create_user();
$manager = $generator->create_user();
$generator->enrol_user($manager->id, $course->id, 'manager');
// Two sections have content - one is hidden.
$DB->set_field('course_sections', 'name', 'Frogs',
['course' => $course->id, 'section' => 1]);
$DB->set_field('course_sections', 'name', 'Toads',
['course' => $course->id, 'section' => 2]);
$DB->set_field('course_sections', 'visible', '0',
['course' => $course->id, 'section' => 2]);
// Make the modified time be in order of sections.
$DB->execute('UPDATE {course_sections} SET timemodified = section');
// Get the two document objects.
$rs = $searcharea->get_document_recordset();
$documents = [];
$index = 0;
foreach ($rs as $rec) {
$documents[$index++] = $searcharea->get_document($rec);
}
$this->assertCount(2, $documents);
// Log in as admin and check access.
$this->setAdminUser();
$this->assertEquals(\core_search\manager::ACCESS_GRANTED,
$searcharea->check_access($documents[0]->get('itemid')));
$this->assertEquals(\core_search\manager::ACCESS_GRANTED,
$searcharea->check_access($documents[1]->get('itemid')));
// Log in as manager and check access.
$this->setUser($manager);
$this->assertEquals(\core_search\manager::ACCESS_GRANTED,
$searcharea->check_access($documents[0]->get('itemid')));
$this->assertEquals(\core_search\manager::ACCESS_GRANTED,
$searcharea->check_access($documents[1]->get('itemid')));
// Log in as student and check access - none yet.
$this->setUser($student);
$this->assertEquals(\core_search\manager::ACCESS_DENIED,
$searcharea->check_access($documents[0]->get('itemid')));
$this->assertEquals(\core_search\manager::ACCESS_DENIED,
$searcharea->check_access($documents[1]->get('itemid')));
// Enrol student - now they should get access but not to the hidden one.
$generator->enrol_user($student->id, $course->id, 'student');
$this->assertEquals(\core_search\manager::ACCESS_GRANTED,
$searcharea->check_access($documents[0]->get('itemid')));
$this->assertEquals(\core_search\manager::ACCESS_DENIED,
$searcharea->check_access($documents[1]->get('itemid')));
// Delete the course and check it returns deleted.
delete_course($course, false);
$this->assertEquals(\core_search\manager::ACCESS_DELETED,
$searcharea->check_access($documents[0]->get('itemid')));
$this->assertEquals(\core_search\manager::ACCESS_DELETED,
$searcharea->check_access($documents[1]->get('itemid')));
}
}
lang/en/search.php
+1
View File
@@ -100,6 +100,7 @@ $string['search'] = 'Search';
$string['search:message_received'] = 'Messages - received';
$string['search:message_sent'] = 'Messages - sent';
$string['search:mycourse'] = 'My courses';
$string['search:section'] = 'Course sections';
$string['search:user'] = 'Users';
$string['searcharea'] = 'Search area';
$string['searching'] = 'Searching in ...';