4bbb631b19416fefce2a3789e39397ca8d944be8
[moodle.git] / search / classes / engine.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  * Base class for search engines.
19  *
20  * All search engines must extend this class.
21  *
22  * @package   core_search
23  * @copyright 2015 Daniel Neis
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 namespace core_search;
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Base class for search engines.
33  *
34  * All search engines must extend this class.
35  *
36  * @package   core_search
37  * @copyright 2015 Daniel Neis
38  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 abstract class engine {
42     /**
43      * The search engine configuration.
44      *
45      * @var \stdClass
46      */
47     protected $config = null;
49     /**
50      * Last executed query error, if there was any.
51      * @var string
52      */
53     protected $queryerror = null;
55     /**
56      * @var array Internal cache.
57      */
58     protected $cachedareas = array();
60     /**
61      * @var array Internal cache.
62      */
63     protected $cachedcourses = array();
65     /**
66      * User data required to show their fullnames. Indexed by userid.
67      *
68      * @var \stdClass[]
69      */
70     protected static $cachedusers = array();
72     /**
73      * @var string Frankenstyle plugin name.
74      */
75     protected $pluginname = null;
77     /**
78      * Initialises the search engine configuration.
79      *
80      * Search engine availability should be checked separately.
81      *
82      * @return void
83      */
84     public function __construct() {
86         $classname = get_class($this);
87         if (strpos($classname, '\\') === false) {
88             throw new \coding_exception('"' . $classname . '" class should specify its component namespace and it should be named engine.');
89         } else if (strpos($classname, '_') === false) {
90             throw new \coding_exception('"' . $classname . '" class namespace should be its frankenstyle name');
91         }
93         // This is search_xxxx config.
94         $this->pluginname = substr($classname, 0, strpos($classname, '\\'));
95         if ($config = get_config($this->pluginname)) {
96             $this->config = $config;
97         } else {
98             $this->config = new stdClass();
99         }
100     }
102     /**
103      * Returns a course instance checking internal caching.
104      *
105      * @param int $courseid
106      * @return stdClass
107      */
108     protected function get_course($courseid) {
109         if (!empty($this->cachedcourses[$courseid])) {
110             return $this->cachedcourses[$courseid];
111         }
113         // No need to clone, only read.
114         $this->cachedcourses[$courseid] = get_course($courseid, false);
116         return $this->cachedcourses[$courseid];
117     }
119     /**
120      * Returns user data checking the internal static cache.
121      *
122      * Including here the minimum required user information as this may grow big.
123      *
124      * @param int $userid
125      * @return stdClass
126      */
127     public function get_user($userid) {
128         global $DB;
130         if (empty(self::$cachedusers[$userid])) {
131             $fields = get_all_user_name_fields(true);
132             self::$cachedusers[$userid] = $DB->get_record('user', array('id' => $userid), 'id, ' . $fields);
133         }
134         return self::$cachedusers[$userid];
135     }
137     /**
138      * Returns a search instance of the specified area checking internal caching.
139      *
140      * @param string $areaid Area id
141      * @return \core_search\base
142      */
143     protected function get_search_area($areaid) {
145         if (isset($this->cachedareas[$areaid]) && $this->cachedareas[$areaid] === false) {
146             // We already checked that area and it is not available.
147             return false;
148         }
150         if (!isset($this->cachedareas[$areaid])) {
151             // First result that matches this area.
153             $this->cachedareas[$areaid] = \core_search\manager::get_search_area($areaid);
154             if ($this->cachedareas[$areaid] === false) {
155                 // The area does not exist or it is not available any more.
157                 $this->cachedareas[$areaid] = false;
158                 return false;
159             }
161             if (!$this->cachedareas[$areaid]->is_enabled()) {
162                 // We skip the area if it is not enabled.
164                 // Marking it as false so next time we don' need to check it again.
165                 $this->cachedareas[$areaid] = false;
167                 return false;
168             }
169         }
171         return $this->cachedareas[$areaid];
172     }
174     /**
175      * Returns a document instance prepared to be rendered.
176      *
177      * @param \core_search\base $searcharea
178      * @param array $docdata
179      * @return \core_search\document
180      */
181     protected function to_document(\core_search\base $searcharea, $docdata) {
183         list($componentname, $areaname) = \core_search\manager::extract_areaid_parts($docdata['areaid']);
184         $doc = \core_search\document_factory::instance($docdata['itemid'], $componentname, $areaname, $this);
185         $doc->set_data_from_engine($docdata);
186         $doc->set_doc_url($searcharea->get_doc_url($doc));
187         $doc->set_context_url($searcharea->get_context_url($doc));
189         // Uses the internal caches to get required data needed to render the document later.
190         $course = $this->get_course($doc->get('courseid'));
191         $doc->set_extra('coursefullname', $course->fullname);
193         if ($doc->is_set('userid')) {
194             $user = $this->get_user($doc->get('userid'));
195             $doc->set_extra('userfullname', fullname($user));
196         }
198         return $doc;
199     }
201     /**
202      * Loop through given iterator of search documents
203      * and and have the search engine back end add them
204      * to the index.
205      *
206      * @param iterator $iterator the iterator of documents to index
207      * @param searcharea $searcharea the area for the documents to index
208      * @param array $options document indexing options
209      * @return array Processed document counts
210      */
211     public function add_documents($iterator, $searcharea, $options) {
212         $numrecords = 0;
213         $numdocs = 0;
214         $numdocsignored = 0;
215         $lastindexeddoc = 0;
216         $firstindexeddoc = 0;
217         $partial = false;
218         $lastprogress = manager::get_current_time();
220         foreach ($iterator as $document) {
221             // Stop if we have exceeded the time limit (and there are still more items). Always
222             // do at least one second's worth of documents otherwise it will never make progress.
223             if ($lastindexeddoc !== $firstindexeddoc &&
224                     !empty($options['stopat']) && manager::get_current_time() >= $options['stopat']) {
225                 $partial = true;
226                 break;
227             }
229             if (!$document instanceof \core_search\document) {
230                 continue;
231             }
233             if (isset($options['lastindexedtime']) && $options['lastindexedtime'] == 0) {
234                 // If we have never indexed this area before, it must be new.
235                 $document->set_is_new(true);
236             }
238             if ($options['indexfiles']) {
239                 // Attach files if we are indexing.
240                 $searcharea->attach_files($document);
241             }
243             if ($this->add_document($document, $options['indexfiles'])) {
244                 $numdocs++;
245             } else {
246                 $numdocsignored++;
247             }
249             $lastindexeddoc = $document->get('modified');
250             if (!$firstindexeddoc) {
251                 $firstindexeddoc = $lastindexeddoc;
252             }
253             $numrecords++;
255             // If indexing the area takes a long time, periodically output progress information.
256             if (isset($options['progress'])) {
257                 $now = manager::get_current_time();
258                 if ($now - $lastprogress >= manager::DISPLAY_INDEXING_PROGRESS_EVERY) {
259                     $lastprogress = $now;
260                     // The first date format is the same used in cron_trace_time_and_memory().
261                     $options['progress']->output(date('H:i:s', $now) . ': Done to ' . userdate(
262                             $lastindexeddoc, get_string('strftimedatetimeshort', 'langconfig')), 1);
263                 }
264             }
265         }
267         return array($numrecords, $numdocs, $numdocsignored, $lastindexeddoc, $partial);
268     }
270     /**
271      * Returns the plugin name.
272      *
273      * @return string Frankenstyle plugin name.
274      */
275     public function get_plugin_name() {
276         return $this->pluginname;
277     }
279     /**
280      * Gets the document class used by this search engine.
281      *
282      * Search engines can overwrite \core_search\document with \search_ENGINENAME\document class.
283      *
284      * Looks for a document class in the current search engine namespace, falling back to \core_search\document.
286      * Publicly available because search areas do not have access to the engine details,
287      * \core_search\document_factory accesses this function.
288      *
289      * @return string
290      */
291     public function get_document_classname() {
292         $classname = $this->pluginname . '\\document';
293         if (!class_exists($classname)) {
294             $classname = '\\core_search\\document';
295         }
296         return $classname;
297     }
299     /**
300      * Run any pre-indexing operations.
301      *
302      * Should be overwritten if the search engine needs to do any pre index preparation.
303      *
304      * @param bool $fullindex True if a full index will be performed
305      * @return void
306      */
307     public function index_starting($fullindex = false) {
308         // Nothing by default.
309     }
311     /**
312      * Run any post indexing operations.
313      *
314      * Should be overwritten if the search engine needs to do any post index cleanup.
315      *
316      * @param int $numdocs The number of documents that were added to the index
317      * @param bool $fullindex True if a full index was performed
318      * @return void
319      */
320     public function index_complete($numdocs = 0, $fullindex = false) {
321         // Nothing by default.
322     }
324     /**
325      * Do anything that may need to be done before an area is indexed.
326      *
327      * @param \core_search\base $searcharea The search area that was complete
328      * @param bool $fullindex True if a full index is being performed
329      * @return void
330      */
331     public function area_index_starting($searcharea, $fullindex = false) {
332         // Nothing by default.
333     }
335     /**
336      * Do any area cleanup needed, and do anything to confirm contents.
337      *
338      * Return false to prevent the search area completed time and stats from being updated.
339      *
340      * @param \core_search\base $searcharea The search area that was complete
341      * @param int $numdocs The number of documents that were added to the index
342      * @param bool $fullindex True if a full index is being performed
343      * @return bool True means that data is considered indexed
344      */
345     public function area_index_complete($searcharea, $numdocs = 0, $fullindex = false) {
346         return true;
347     }
349     /**
350      * Optimizes the search engine.
351      *
352      * Should be overwritten if the search engine can optimize its contents.
353      *
354      * @return void
355      */
356     public function optimize() {
357         // Nothing by default.
358     }
360     /**
361      * Does the system satisfy all the requirements.
362      *
363      * Should be overwritten if the search engine has any system dependencies
364      * that needs to be checked.
365      *
366      * @return bool
367      */
368     public function is_installed() {
369         return true;
370     }
372     /**
373      * Returns any error reported by the search engine when executing the provided query.
374      *
375      * It should be called from static::execute_query when an exception is triggered.
376      *
377      * @return string
378      */
379     public function get_query_error() {
380         return $this->queryerror;
381     }
383     /**
384      * Returns the total number of documents available for the most recent call to execute_query.
385      *
386      * This can be an estimate, but should get more accurate the higher the limited passed to execute_query is.
387      * To do that, the engine can use (actual result returned count + count of unchecked documents), or
388      * (total possible docs - docs that have been checked and rejected).
389      *
390      * Engine can limit to manager::MAX_RESULTS if there is cost to determining more.
391      * If this cannot be computed in a reasonable way, manager::MAX_RESULTS may be returned.
392      *
393      * @return int
394      */
395     abstract public function get_query_total_count();
397     /**
398      * Return true if file indexing is supported and enabled. False otherwise.
399      *
400      * @return bool
401      */
402     public function file_indexing_enabled() {
403         return false;
404     }
406     /**
407      * Clears the current query error value.
408      *
409      * @return void
410      */
411     public function clear_query_error() {
412         $this->queryerror = null;
413     }
415     /**
416      * Is the server ready to use?
417      *
418      * This should also check that the search engine configuration is ok.
419      *
420      * @return true|string Returns true if all good or an error string.
421      */
422     abstract function is_server_ready();
424     /**
425      * Adds a document to the search engine.
426      *
427      * @param document $document
428      * @param bool     $fileindexing True if file indexing is to be used
429      * @return bool    False if the file was skipped or failed, true on success
430      */
431     abstract function add_document($document, $fileindexing = false);
433     /**
434      * Executes the query on the engine.
435      *
436      * Implementations of this function should check user context array to limit the results to contexts where the
437      * user have access. They should also limit the owneruserid field to manger::NO_OWNER_ID or the current user's id.
438      * Engines must use area->check_access() to confirm user access.
439      *
440      * Engines should reasonably attempt to fill up to limit with valid results if they are available.
441      *
442      * The $filters object may include the following fields (optional except q):
443      * - q: value of main search field; results should include this text
444      * - title: if included, title must match this search
445      * - areaids: array of search area id strings (only these areas will be searched)
446      * - courseids: array of course ids (only these courses will be searched)
447      * - groupids: array of group ids (only results specifically from these groupids will be
448      *   searched) - this option will be ignored if the search engine doesn't support groups
449      *
450      * The $accessinfo parameter has two different values (for historical compatibility). If the
451      * engine returns false to supports_group_filtering then it is an array of user contexts, or
452      * true if the user can access all contexts. (This parameter used to be called $usercontexts.)
453      * If the engine returns true to supports_group_filtering then it will be an object containing
454      * these fields:
455      * - everything (true if admin is searching with no restrictions)
456      * - usercontexts (same as above)
457      * - separategroupscontexts (array of context ids where separate groups are used)
458      * - visiblegroupscontextsareas (array of subset of those where some areas use visible groups)
459      * - usergroups (array of relevant group ids that user belongs to)
460      *
461      * The engine should apply group restrictions to those contexts listed in the
462      * 'separategroupscontexts' array. In these contexts, it shouled only include results if the
463      * groupid is not set, or if the groupid matches one of the values in USER_GROUPS array, or
464      * if the search area is one of those listed in 'visiblegroupscontextsareas' for that context.
465      *
466      * @param \stdClass $filters Query and filters to apply.
467      * @param \stdClass $accessinfo Information about the contexts the user can access
468      * @param  int      $limit The maximum number of results to return. If empty, limit to manager::MAX_RESULTS.
469      * @return \core_search\document[] Results or false if no results
470      */
471     public abstract function execute_query($filters, $accessinfo, $limit = 0);
473     /**
474      * Delete all documents.
475      *
476      * @param string $areaid To filter by area
477      * @return void
478      */
479     abstract function delete($areaid = null);
481     /**
482      * Checks that the schema is the latest version. If the version stored in config does not match
483      * the current, this function will attempt to upgrade the schema.
484      *
485      * @return bool|string True if schema is OK, a string if user needs to take action
486      */
487     public function check_latest_schema() {
488         if (empty($this->config->schemaversion)) {
489             $currentversion = 0;
490         } else {
491             $currentversion = $this->config->schemaversion;
492         }
493         if ($currentversion < document::SCHEMA_VERSION) {
494             return $this->update_schema((int)$currentversion, (int)document::SCHEMA_VERSION);
495         } else {
496             return true;
497         }
498     }
500     /**
501      * Usually called by the engine; marks that the schema has been updated.
502      *
503      * @param int $version Records the schema version now applied
504      */
505     public function record_applied_schema_version($version) {
506         set_config('schemaversion', $version, $this->pluginname);
507     }
509     /**
510      * Requests the search engine to upgrade the schema. The engine should update the schema if
511      * possible/necessary, and should ensure that record_applied_schema_version is called as a
512      * result.
513      *
514      * If it is not possible to upgrade the schema at the moment, it can do nothing and return; the
515      * function will be called again next time search is initialised.
516      *
517      * The default implementation just returns, with a DEBUG_DEVELOPER warning.
518      *
519      * @param int $oldversion Old schema version
520      * @param int $newversion New schema version
521      * @return bool|string True if schema is updated successfully, a string if it needs updating manually
522      */
523     protected function update_schema($oldversion, $newversion) {
524         debugging('Unable to update search engine schema: ' . $this->pluginname, DEBUG_DEVELOPER);
525         return get_string('schemanotupdated', 'search');
526     }
528     /**
529      * Checks if this search engine supports groups.
530      *
531      * Note that returning true to this function causes the parameters to execute_query to be
532      * passed differently!
533      *
534      * In order to implement groups and return true to this function, the search engine should:
535      *
536      * 1. Handle the fields ->separategroupscontexts and ->usergroups in the $accessinfo parameter
537      *    to execute_query (ideally, using these to automatically restrict search results).
538      * 2. Support the optional groupids parameter in the $filter parameter for execute_query to
539      *    restrict results to only those where the stored groupid matches the given value.
540      *
541      * @return bool True if this engine supports searching by group id field
542      */
543     public function supports_group_filtering() {
544         return false;
545     }
547     /**
548      * Obtain a list of results orders (and names for them) that are supported by this
549      * search engine in the given context.
550      *
551      * By default, engines sort by relevance only.
552      *
553      * @param \context $context Context that the user requested search from
554      * @return array Array from order name => display text
555      */
556     public function get_supported_orders(\context $context) {
557         return ['relevance' => get_string('order_relevance', 'search')];
558     }