moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 10:26:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-55356 core_search: Change existing search areas to new API

Browse source 
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
This commit is contained in:
sam marshall 2017-09-11 11:29:26 +01:00
parent 81a988833e
commit 66e3702680
21 changed files with 584 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

18
mod/book/classes/search/chapter.php
View file

@ -43,16 +43,24 @@ class chapter extends \core_search\base_mod {
* Returns a recordset with all required chapter information.
*
* @param int $modifiedfrom
* @return moodle_recordset
* @param \context|null $context Optional context to restrict scope of returned results
* @return moodle_recordset|null Recordset (or null if no results)
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
$sql = 'SELECT c.*, b.id AS bookid, b.course AS courseid
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, 'book', 'b');
if ($contextjoin === null) {
return null;
}
$sql = "SELECT c.*, b.id AS bookid, b.course AS courseid
FROM {book_chapters} c
JOIN {book} b ON b.id = c.bookid
WHERE c.timemodified >= ? ORDER BY c.timemodified ASC';
return $DB->get_recordset_sql($sql, array($modifiedfrom));
$contextjoin
WHERE c.timemodified >= ? ORDER BY c.timemodified ASC";
return $DB->get_recordset_sql($sql, array_merge($contextparams, [$modifiedfrom]));
}
/**

20
mod/book/tests/search_test.php
View file

@ -118,6 +118,26 @@ class mod_book_search_testcase extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Create another book and chapter.
$book2 = $this->getDataGenerator()->create_module('book', array('course' => $course1->id));
$bookgenerator->create_chapter(array('bookid' => $book2->id,
'content' => 'Chapter3', 'title' => 'Title3'));
// Query by context, first book.
$recordset = $searcharea->get_document_recordset(0, \context_module::instance($book->cmid));
$this->assertEquals(2, iterator_count($recordset));
$recordset->close();
// Second book.
$recordset = $searcharea->get_document_recordset(0, \context_module::instance($book2->cmid));
$this->assertEquals(1, iterator_count($recordset));
$recordset->close();
// Course.
$recordset = $searcharea->get_document_recordset(0, \context_course::instance($course1->id));
$this->assertEquals(3, iterator_count($recordset));
$recordset->close();
}
/**

15
mod/data/classes/search/entry.php
View file

@ -47,16 +47,25 @@ class entry extends \core_search\base_mod {
* Returns recordset containing required data for indexing database entries.
*
* @param int $modifiedfrom timestamp
* @return moodle_recordset
* @param \context|null $context Optional context to restrict scope of returned results
* @return moodle_recordset|null Recordset (or null if no results)
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, 'data', 'd', SQL_PARAMS_NAMED);
if ($contextjoin === null) {
return null;
}
$sql = "SELECT dr.*, d.course
FROM {data_records} dr
JOIN {data} d ON d.id = dr.dataid
$contextjoin
WHERE dr.timemodified >= :timemodified";
return $DB->get_recordset_sql($sql, array('timemodified' => $modifiedfrom));
return $DB->get_recordset_sql($sql,
array_merge($contextparams, ['timemodified' => $modifiedfrom]));
}
/**

16
mod/data/tests/search_test.php
View file

@ -314,6 +314,22 @@ class mod_data_search_test extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Create a second database, also with one record.
$data2 = $this->getDataGenerator()->create_module('data', ['course' => $course1->id]);
$this->create_default_data_fields($fieldtypes, $data2);
$this->create_default_data_record($data2);
// Test indexing with contexts.
$rs = $searcharea->get_document_recordset(0, context_module::instance($data1->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_module::instance($data2->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_course::instance($course1->id));
$this->assertEquals(2, iterator_count($rs));
$rs->close();
}
/**

18
mod/forum/classes/search/post.php
View file

@ -56,17 +56,25 @@ class post extends \core_search\base_mod {
* Returns recordset containing required data for indexing forum posts.
*
* @param int $modifiedfrom timestamp
* @return moodle_recordset
* @param \context|null $context Optional context to restrict scope of returned results
* @return moodle_recordset|null Recordset (or null if no results)
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
$sql = 'SELECT fp.*, f.id AS forumid, f.course AS courseid
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, 'forum', 'f');
if ($contextjoin === null) {
return null;
}
$sql = "SELECT fp.*, f.id AS forumid, f.course AS courseid
FROM {forum_posts} fp
JOIN {forum_discussions} fd ON fd.id = fp.discussion
JOIN {forum} f ON f.id = fd.forum
WHERE fp.modified >= ? ORDER BY fp.modified ASC';
return $DB->get_recordset_sql($sql, array($modifiedfrom));
$contextjoin
WHERE fp.modified >= ? ORDER BY fp.modified ASC";
return $DB->get_recordset_sql($sql, array_merge($contextparams, [$modifiedfrom]));
}
/**

20
mod/forum/tests/search_test.php
View file

@ -144,6 +144,26 @@ class mod_forum_search_testcase extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Context test: create another forum with 1 post.
$forum2 = self::getDataGenerator()->create_module('forum', ['course' => $course1->id]);
$record = new stdClass();
$record->course = $course1->id;
$record->userid = $user1->id;
$record->forum = $forum2->id;
$record->message = 'discussion';
self::getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
// Test indexing with each forum then combined course context.
$rs = $searcharea->get_document_recordset(0, context_module::instance($forum1->cmid));
$this->assertEquals(2, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_module::instance($forum2->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_course::instance($course1->id));
$this->assertEquals(3, iterator_count($rs));
$rs->close();
}
/**

16
mod/glossary/classes/search/entry.php
View file

@ -46,15 +46,23 @@ class entry extends \core_search\base_mod {
* Returns recordset containing required data for indexing glossary entries.
*
* @param int $modifiedfrom timestamp
* @return moodle_recordset
* @param \context|null $context Optional context to restrict scope of returned results
* @return moodle_recordset|null Recordset (or null if no results)
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, 'glossary', 'g');
if ($contextjoin === null) {
return null;
}
$sql = "SELECT ge.*, g.course FROM {glossary_entries} ge
JOIN {glossary} g ON g.id = ge.glossaryid
WHERE ge.timemodified >= ? ORDER BY ge.timemodified ASC";
return $DB->get_recordset_sql($sql, array($modifiedfrom));
$contextjoin
WHERE ge.timemodified >= ? ORDER BY ge.timemodified ASC";
return $DB->get_recordset_sql($sql, array_merge($contextparams, [$modifiedfrom]));
}
/**

15
mod/glossary/tests/search_test.php
View file

@ -132,6 +132,21 @@ class mod_glossary_search_testcase extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Create a second glossary with one entry.
$glossary2 = self::getDataGenerator()->create_module('glossary', ['course' => $course1->id]);
self::getDataGenerator()->get_plugin_generator('mod_glossary')->create_content($glossary2);
// Test indexing with each activity then combined course context.
$rs = $searcharea->get_document_recordset(0, context_module::instance($glossary1->cmid));
$this->assertEquals(2, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_module::instance($glossary2->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_course::instance($course1->id));
$this->assertEquals(3, iterator_count($rs));
$rs->close();
}
/**

20
mod/survey/classes/search/activity.php
View file

@ -47,16 +47,24 @@ class activity extends \core_search\base_activity {
/**
* Returns recordset containing required data for indexing activities.
*
* Overwritten to discard records with courseid = 0.
* Overridden to discard records with courseid = 0.
*
* @param int $modifiedfrom timestamp
* @return \moodle_recordset
* @param \context|null $context Context
* @return \moodle_recordset|null Recordset, or null if no possible activities in given context
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
$select = 'course != ? AND ' . static::MODIFIED_FIELD_NAME . ' >= ?';
return $DB->get_recordset_select($this->get_module_name(), $select, array(0, $modifiedfrom),
static::MODIFIED_FIELD_NAME . ' ASC');
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, $this->get_module_name(), 'modtable');
if ($contextjoin === null) {
return null;
}
return $DB->get_recordset_sql('SELECT modtable.* FROM {' . $this->get_module_name() .
'} modtable ' . $contextjoin . ' WHERE modtable.' . static::MODIFIED_FIELD_NAME .
' >= ? AND modtable.course != ? ORDER BY modtable.' . static::MODIFIED_FIELD_NAME .
' ASC',
array_merge($contextparams, [$modifiedfrom, 0]));
}
}

75
mod/survey/tests/search_test.php Normal file
View file

@ -0,0 +1,75 @@
<?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/>.
/**
* Unit test for mod_survey searching.
*
* This is needed because the activity.php class overrides default behaviour.
*
* @package mod_survey
* @category test
* @copyright 2017 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Unit test for mod_survey searching.
*
* This is needed because the activity.php class overrides default behaviour.
*
* @package mod_survey
* @category test
* @copyright 2017 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class mod_survey_search_testcase extends advanced_testcase {
/**
* Test survey_view
* @return void
*/
public function test_survey_indexing() {
global $CFG;
$this->resetAfterTest();
require_once($CFG->dirroot . '/search/tests/fixtures/testable_core_search.php');
testable_core_search::instance();
$area = \core_search\manager::get_search_area('mod_survey-activity');
// Setup test data.
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$survey1 = $generator->create_module('survey', ['course' => $course->id]);
$survey2 = $generator->create_module('survey', ['course' => $course->id]);
// Get all surveys for indexing - note that there are special entries in the table with
// course zero which should not be returned.
$rs = $area->get_document_recordset();
$this->assertEquals(2, iterator_count($rs));
$rs->close();
// Test specific context and course context.
$rs = $area->get_document_recordset(0, context_module::instance($survey1->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $area->get_document_recordset(0, context_course::instance($course->id));
$this->assertEquals(2, iterator_count($rs));
$rs->close();
}
}

19
mod/wiki/classes/search/collaborative_page.php
View file

@ -45,19 +45,28 @@ class collaborative_page extends \core_search\base_mod {
* Returns a recordset with all required page information.
*
* @param int $modifiedfrom
* @return moodle_recordset
* @param \context|null $context Optional context to restrict scope of returned results
* @return moodle_recordset|null Recordset (or null if no results)
*/
public function get_recordset_by_timestamp($modifiedfrom = 0) {
public function get_document_recordset($modifiedfrom = 0, \context $context = null) {
global $DB;
$sql = 'SELECT p.*, w.id AS wikiid, w.course AS courseid
list ($contextjoin, $contextparams) = $this->get_context_restriction_sql(
$context, 'wiki', 'w');
if ($contextjoin === null) {
return null;
}
$sql = "SELECT p.*, w.id AS wikiid, w.course AS courseid
FROM {wiki_pages} p
JOIN {wiki_subwikis} s ON s.id = p.subwikiid
JOIN {wiki} w ON w.id = s.wikiid
$contextjoin
WHERE p.timemodified >= ?
AND w.wikimode = ?
ORDER BY p.timemodified ASC';
return $DB->get_recordset_sql($sql, array($modifiedfrom, 'collaborative'));
ORDER BY p.timemodified ASC";
return $DB->get_recordset_sql($sql, array_merge($contextparams,
[$modifiedfrom, 'collaborative']));
}
/**

15
mod/wiki/tests/search_test.php
View file

@ -126,6 +126,21 @@ class mod_wiki_search_testcase extends advanced_testcase {
// No new records.
$this->assertFalse($recordset->valid());
$recordset->close();
// Add another wiki with one page.
$collabwiki2 = $this->getDataGenerator()->create_module('wiki', ['course' => $course1->id]);
$wikigenerator->create_first_page($collabwiki2);
// Test indexing contexts.
$rs = $searcharea->get_document_recordset(0, context_module::instance($collabwiki->cmid));
$this->assertEquals(3, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_module::instance($collabwiki2->cmid));
$this->assertEquals(1, iterator_count($rs));
$rs->close();
$rs = $searcharea->get_document_recordset(0, context_course::instance($course1->id));
$this->assertEquals(4, iterator_count($rs));
$rs->close();
}
/**