MDL-68334 user: Display name in footer as elsewhere.
[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      * @var bool If true, should skip schema validity check when checking the search engine is ready
79      */
80     protected $skipschemacheck = false;
82     /**
83      * Initialises the search engine configuration.
84      *
85      * Search engine availability should be checked separately.
86      *
87      * @return void
88      */
89     public function __construct() {
91         $classname = get_class($this);
92         if (strpos($classname, '\\') === false) {
93             throw new \coding_exception('"' . $classname . '" class should specify its component namespace and it should be named engine.');
94         } else if (strpos($classname, '_') === false) {
95             throw new \coding_exception('"' . $classname . '" class namespace should be its frankenstyle name');
96         }
98         // This is search_xxxx config.
99         $this->pluginname = substr($classname, 0, strpos($classname, '\\'));
100         if ($config = get_config($this->pluginname)) {
101             $this->config = $config;
102         } else {
103             $this->config = new stdClass();
104         }
105     }
107     /**
108      * Returns a course instance checking internal caching.
109      *
110      * @param int $courseid
111      * @return stdClass
112      */
113     protected function get_course($courseid) {
114         if (!empty($this->cachedcourses[$courseid])) {
115             return $this->cachedcourses[$courseid];
116         }
118         // No need to clone, only read.
119         $this->cachedcourses[$courseid] = get_course($courseid, false);
121         return $this->cachedcourses[$courseid];
122     }
124     /**
125      * Returns user data checking the internal static cache.
126      *
127      * Including here the minimum required user information as this may grow big.
128      *
129      * @param int $userid
130      * @return stdClass
131      */
132     public function get_user($userid) {
133         global $DB;
135         if (empty(self::$cachedusers[$userid])) {
136             $fields = get_all_user_name_fields(true);
137             self::$cachedusers[$userid] = $DB->get_record('user', array('id' => $userid), 'id, ' . $fields);
138         }
139         return self::$cachedusers[$userid];
140     }
142     /**
143      * Clears the users cache.
144      *
145      * @return null
146      */
147     public static function clear_users_cache() {
148         self::$cachedusers = [];
149     }
151     /**
152      * Returns a search instance of the specified area checking internal caching.
153      *
154      * @param string $areaid Area id
155      * @return \core_search\base
156      */
157     protected function get_search_area($areaid) {
159         if (isset($this->cachedareas[$areaid]) && $this->cachedareas[$areaid] === false) {
160             // We already checked that area and it is not available.
161             return false;
162         }
164         if (!isset($this->cachedareas[$areaid])) {
165             // First result that matches this area.
167             $this->cachedareas[$areaid] = \core_search\manager::get_search_area($areaid);
168             if ($this->cachedareas[$areaid] === false) {
169                 // The area does not exist or it is not available any more.
171                 $this->cachedareas[$areaid] = false;
172                 return false;
173             }
175             if (!$this->cachedareas[$areaid]->is_enabled()) {
176                 // We skip the area if it is not enabled.
178                 // Marking it as false so next time we don' need to check it again.
179                 $this->cachedareas[$areaid] = false;
181                 return false;
182             }
183         }
185         return $this->cachedareas[$areaid];
186     }
188     /**
189      * Returns a document instance prepared to be rendered.
190      *
191      * @param \core_search\base $searcharea
192      * @param array $docdata
193      * @return \core_search\document
194      */
195     protected function to_document(\core_search\base $searcharea, $docdata) {
197         list($componentname, $areaname) = \core_search\manager::extract_areaid_parts($docdata['areaid']);
198         $doc = \core_search\document_factory::instance($docdata['itemid'], $componentname, $areaname, $this);
199         $doc->set_data_from_engine($docdata);
200         $doc->set_doc_url($searcharea->get_doc_url($doc));
201         $doc->set_context_url($searcharea->get_context_url($doc));
202         $doc->set_doc_icon($searcharea->get_doc_icon($doc));
204         // Uses the internal caches to get required data needed to render the document later.
205         $course = $this->get_course($doc->get('courseid'));
206         $doc->set_extra('coursefullname', $course->fullname);
208         if ($doc->is_set('userid')) {
209             $user = $this->get_user($doc->get('userid'));
210             $doc->set_extra('userfullname', fullname($user));
211         }
213         return $doc;
214     }
216     /**
217      * Loop through given iterator of search documents
218      * and and have the search engine back end add them
219      * to the index.
220      *
221      * @param \iterator $iterator the iterator of documents to index
222      * @param base $searcharea the area for the documents to index
223      * @param array $options document indexing options
224      * @return array Processed document counts
225      */
226     public function add_documents($iterator, $searcharea, $options) {
227         $numrecords = 0;
228         $numdocs = 0;
229         $numdocsignored = 0;
230         $numbatches = 0;
231         $lastindexeddoc = 0;
232         $firstindexeddoc = 0;
233         $partial = false;
234         $lastprogress = manager::get_current_time();
236         $batchmode = $this->supports_add_document_batch();
237         $currentbatch = [];
239         foreach ($iterator as $document) {
240             // Stop if we have exceeded the time limit (and there are still more items). Always
241             // do at least one second's worth of documents otherwise it will never make progress.
242             if ($lastindexeddoc !== $firstindexeddoc &&
243                     !empty($options['stopat']) && manager::get_current_time() >= $options['stopat']) {
244                 $partial = true;
245                 break;
246             }
248             if (!$document instanceof \core_search\document) {
249                 continue;
250             }
252             if (isset($options['lastindexedtime']) && $options['lastindexedtime'] == 0) {
253                 // If we have never indexed this area before, it must be new.
254                 $document->set_is_new(true);
255             }
257             if ($options['indexfiles']) {
258                 // Attach files if we are indexing.
259                 $searcharea->attach_files($document);
260             }
262             if ($batchmode && strlen($document->get('content')) <= $this->get_batch_max_content()) {
263                 $currentbatch[] = $document;
264                 if (count($currentbatch) >= $this->get_batch_max_documents()) {
265                     [$processed, $failed, $batches] = $this->add_document_batch($currentbatch, $options['indexfiles']);
266                     $numdocs += $processed;
267                     $numdocsignored += $failed;
268                     $numbatches += $batches;
269                     $currentbatch = [];
270                 }
271             } else {
272                 if ($this->add_document($document, $options['indexfiles'])) {
273                     $numdocs++;
274                 } else {
275                     $numdocsignored++;
276                 }
277                 $numbatches++;
278             }
280             $lastindexeddoc = $document->get('modified');
281             if (!$firstindexeddoc) {
282                 $firstindexeddoc = $lastindexeddoc;
283             }
284             $numrecords++;
286             // If indexing the area takes a long time, periodically output progress information.
287             if (isset($options['progress'])) {
288                 $now = manager::get_current_time();
289                 if ($now - $lastprogress >= manager::DISPLAY_INDEXING_PROGRESS_EVERY) {
290                     $lastprogress = $now;
291                     // The first date format is the same used in cron_trace_time_and_memory().
292                     $options['progress']->output(date('H:i:s', $now) . ': Done to ' . userdate(
293                             $lastindexeddoc, get_string('strftimedatetimeshort', 'langconfig')), 1);
294                 }
295             }
296         }
298         // Add remaining documents from batch.
299         if ($batchmode && $currentbatch) {
300             [$processed, $failed, $batches] = $this->add_document_batch($currentbatch, $options['indexfiles']);
301             $numdocs += $processed;
302             $numdocsignored += $failed;
303             $numbatches += $batches;
304         }
306         return [$numrecords, $numdocs, $numdocsignored, $lastindexeddoc, $partial, $numbatches];
307     }
309     /**
310      * Returns the plugin name.
311      *
312      * @return string Frankenstyle plugin name.
313      */
314     public function get_plugin_name() {
315         return $this->pluginname;
316     }
318     /**
319      * Gets the document class used by this search engine.
320      *
321      * Search engines can overwrite \core_search\document with \search_ENGINENAME\document class.
322      *
323      * Looks for a document class in the current search engine namespace, falling back to \core_search\document.
325      * Publicly available because search areas do not have access to the engine details,
326      * \core_search\document_factory accesses this function.
327      *
328      * @return string
329      */
330     public function get_document_classname() {
331         $classname = $this->pluginname . '\\document';
332         if (!class_exists($classname)) {
333             $classname = '\\core_search\\document';
334         }
335         return $classname;
336     }
338     /**
339      * Run any pre-indexing operations.
340      *
341      * Should be overwritten if the search engine needs to do any pre index preparation.
342      *
343      * @param bool $fullindex True if a full index will be performed
344      * @return void
345      */
346     public function index_starting($fullindex = false) {
347         // Nothing by default.
348     }
350     /**
351      * Run any post indexing operations.
352      *
353      * Should be overwritten if the search engine needs to do any post index cleanup.
354      *
355      * @param int $numdocs The number of documents that were added to the index
356      * @param bool $fullindex True if a full index was performed
357      * @return void
358      */
359     public function index_complete($numdocs = 0, $fullindex = false) {
360         // Nothing by default.
361     }
363     /**
364      * Do anything that may need to be done before an area is indexed.
365      *
366      * @param \core_search\base $searcharea The search area that was complete
367      * @param bool $fullindex True if a full index is being performed
368      * @return void
369      */
370     public function area_index_starting($searcharea, $fullindex = false) {
371         // Nothing by default.
372     }
374     /**
375      * Do any area cleanup needed, and do anything to confirm contents.
376      *
377      * Return false to prevent the search area completed time and stats from being updated.
378      *
379      * @param \core_search\base $searcharea The search area that was complete
380      * @param int $numdocs The number of documents that were added to the index
381      * @param bool $fullindex True if a full index is being performed
382      * @return bool True means that data is considered indexed
383      */
384     public function area_index_complete($searcharea, $numdocs = 0, $fullindex = false) {
385         return true;
386     }
388     /**
389      * Optimizes the search engine.
390      *
391      * Should be overwritten if the search engine can optimize its contents.
392      *
393      * @return void
394      */
395     public function optimize() {
396         // Nothing by default.
397         mtrace('The ' . get_string('pluginname', $this->get_plugin_name()) .
398                 ' search engine does not require automatic optimization.');
399     }
401     /**
402      * Does the system satisfy all the requirements.
403      *
404      * Should be overwritten if the search engine has any system dependencies
405      * that needs to be checked.
406      *
407      * @return bool
408      */
409     public function is_installed() {
410         return true;
411     }
413     /**
414      * Returns any error reported by the search engine when executing the provided query.
415      *
416      * It should be called from static::execute_query when an exception is triggered.
417      *
418      * @return string
419      */
420     public function get_query_error() {
421         return $this->queryerror;
422     }
424     /**
425      * Returns the total number of documents available for the most recent call to execute_query.
426      *
427      * This can be an estimate, but should get more accurate the higher the limited passed to execute_query is.
428      * To do that, the engine can use (actual result returned count + count of unchecked documents), or
429      * (total possible docs - docs that have been checked and rejected).
430      *
431      * Engine can limit to manager::MAX_RESULTS if there is cost to determining more.
432      * If this cannot be computed in a reasonable way, manager::MAX_RESULTS may be returned.
433      *
434      * @return int
435      */
436     abstract public function get_query_total_count();
438     /**
439      * Return true if file indexing is supported and enabled. False otherwise.
440      *
441      * @return bool
442      */
443     public function file_indexing_enabled() {
444         return false;
445     }
447     /**
448      * Clears the current query error value.
449      *
450      * @return void
451      */
452     public function clear_query_error() {
453         $this->queryerror = null;
454     }
456     /**
457      * Is the server ready to use?
458      *
459      * This should also check that the search engine configuration is ok.
460      *
461      * If the function $this->should_skip_schema_check() returns true, then this function may leave
462      * out time-consuming checks that the schema is valid. (This allows for improved performance on
463      * critical pages such as the main search form.)
464      *
465      * @return true|string Returns true if all good or an error string.
466      */
467     abstract function is_server_ready();
469     /**
470      * Tells the search engine to skip any time-consuming checks that it might do as part of the
471      * is_server_ready function, and only carry out a basic check that it can contact the server.
472      *
473      * This setting is not remembered and applies only to the current request.
474      *
475      * @since Moodle 3.5
476      * @param bool $skip True to skip the checks, false to start checking again
477      */
478     public function skip_schema_check($skip = true) {
479         $this->skipschemacheck = $skip;
480     }
482     /**
483      * For use by subclasses. The engine can call this inside is_server_ready to check whether it
484      * should skip time-consuming schema checks.
485      *
486      * @since Moodle 3.5
487      * @return bool True if schema checks should be skipped
488      */
489     protected function should_skip_schema_check() {
490         return $this->skipschemacheck;
491     }
493     /**
494      * Adds a document to the search engine.
495      *
496      * @param document $document
497      * @param bool     $fileindexing True if file indexing is to be used
498      * @return bool    False if the file was skipped or failed, true on success
499      */
500     abstract function add_document($document, $fileindexing = false);
502     /**
503      * Adds multiple documents to the search engine.
504      *
505      * It should return the number successfully processed, and the number of batches they were
506      * processed in (for example if you add 100 documents and there is an error processing one of
507      * those documents, and it took 4 batches, it would return [99, 1, 4]).
508      *
509      * If the engine implements this, it should return true to {@see supports_add_document_batch}.
510      *
511      * The system will only call this function with up to {@see get_batch_max_documents} documents,
512      * and each document in the batch will have content no larger than specified by
513      * {@see get_batch_max_content}.
514      *
515      * @param document[] $documents Documents to add
516      * @param bool $fileindexing True if file indexing is to be used
517      * @return int[] Array of three elements, successfully processed, failed processed, batch count
518      */
519     public function add_document_batch(array $documents, bool $fileindexing = false): array {
520         throw new \coding_exception('add_document_batch not supported by this engine');
521     }
523     /**
524      * Executes the query on the engine.
525      *
526      * Implementations of this function should check user context array to limit the results to contexts where the
527      * user have access. They should also limit the owneruserid field to manger::NO_OWNER_ID or the current user's id.
528      * Engines must use area->check_access() to confirm user access.
529      *
530      * Engines should reasonably attempt to fill up to limit with valid results if they are available.
531      *
532      * The $filters object may include the following fields (optional except q):
533      * - q: value of main search field; results should include this text
534      * - title: if included, title must match this search
535      * - areaids: array of search area id strings (only these areas will be searched)
536      * - courseids: array of course ids (only these courses will be searched)
537      * - groupids: array of group ids (only results specifically from these groupids will be
538      *   searched) - this option will be ignored if the search engine doesn't support groups
539      *
540      * The $accessinfo parameter has two different values (for historical compatibility). If the
541      * engine returns false to supports_group_filtering then it is an array of user contexts, or
542      * true if the user can access all contexts. (This parameter used to be called $usercontexts.)
543      * If the engine returns true to supports_group_filtering then it will be an object containing
544      * these fields:
545      * - everything (true if admin is searching with no restrictions)
546      * - usercontexts (same as above)
547      * - separategroupscontexts (array of context ids where separate groups are used)
548      * - visiblegroupscontextsareas (array of subset of those where some areas use visible groups)
549      * - usergroups (array of relevant group ids that user belongs to)
550      *
551      * The engine should apply group restrictions to those contexts listed in the
552      * 'separategroupscontexts' array. In these contexts, it shouled only include results if the
553      * groupid is not set, or if the groupid matches one of the values in USER_GROUPS array, or
554      * if the search area is one of those listed in 'visiblegroupscontextsareas' for that context.
555      *
556      * @param \stdClass $filters Query and filters to apply.
557      * @param \stdClass $accessinfo Information about the contexts the user can access
558      * @param  int      $limit The maximum number of results to return. If empty, limit to manager::MAX_RESULTS.
559      * @return \core_search\document[] Results or false if no results
560      */
561     public abstract function execute_query($filters, $accessinfo, $limit = 0);
563     /**
564      * Delete all documents.
565      *
566      * @param string $areaid To filter by area
567      * @return void
568      */
569     abstract function delete($areaid = null);
571     /**
572      * Deletes information related to a specific context id. This should be used when the context
573      * itself is deleted from Moodle.
574      *
575      * This only deletes information for the specified context - not for any child contexts.
576      *
577      * This function is optional; if not supported it will return false and the information will
578      * not be deleted from the search index.
579      *
580      * If an engine implements this function it should also implement delete_index_for_course;
581      * otherwise, nothing will be deleted when users delete an entire course at once.
582      *
583      * @param int $oldcontextid ID of context that has been deleted
584      * @return bool True if implemented
585      * @throws \core_search\engine_exception Engines may throw this exception for any problem
586      */
587     public function delete_index_for_context(int $oldcontextid) {
588         return false;
589     }
591     /**
592      * Deletes information related to a specific course id. This should be used when the course
593      * itself is deleted from Moodle.
594      *
595      * This deletes all information relating to that course from the index, including all child
596      * contexts.
597      *
598      * This function is optional; if not supported it will return false and the information will
599      * not be deleted from the search index.
600      *
601      * If an engine implements this function then, ideally, it should also implement
602      * delete_index_for_context so that deletion of single activities/blocks also works.
603      *
604      * @param int $oldcourseid ID of course that has been deleted
605      * @return bool True if implemented
606      * @throws \core_search\engine_exception Engines may throw this exception for any problem
607      */
608     public function delete_index_for_course(int $oldcourseid) {
609         return false;
610     }
612     /**
613      * Checks that the schema is the latest version. If the version stored in config does not match
614      * the current, this function will attempt to upgrade the schema.
615      *
616      * @return bool|string True if schema is OK, a string if user needs to take action
617      */
618     public function check_latest_schema() {
619         if (empty($this->config->schemaversion)) {
620             $currentversion = 0;
621         } else {
622             $currentversion = $this->config->schemaversion;
623         }
624         if ($currentversion < document::SCHEMA_VERSION) {
625             return $this->update_schema((int)$currentversion, (int)document::SCHEMA_VERSION);
626         } else {
627             return true;
628         }
629     }
631     /**
632      * Usually called by the engine; marks that the schema has been updated.
633      *
634      * @param int $version Records the schema version now applied
635      */
636     public function record_applied_schema_version($version) {
637         set_config('schemaversion', $version, $this->pluginname);
638     }
640     /**
641      * Requests the search engine to upgrade the schema. The engine should update the schema if
642      * possible/necessary, and should ensure that record_applied_schema_version is called as a
643      * result.
644      *
645      * If it is not possible to upgrade the schema at the moment, it can do nothing and return; the
646      * function will be called again next time search is initialised.
647      *
648      * The default implementation just returns, with a DEBUG_DEVELOPER warning.
649      *
650      * @param int $oldversion Old schema version
651      * @param int $newversion New schema version
652      * @return bool|string True if schema is updated successfully, a string if it needs updating manually
653      */
654     protected function update_schema($oldversion, $newversion) {
655         debugging('Unable to update search engine schema: ' . $this->pluginname, DEBUG_DEVELOPER);
656         return get_string('schemanotupdated', 'search');
657     }
659     /**
660      * Checks if this search engine supports groups.
661      *
662      * Note that returning true to this function causes the parameters to execute_query to be
663      * passed differently!
664      *
665      * In order to implement groups and return true to this function, the search engine should:
666      *
667      * 1. Handle the fields ->separategroupscontexts and ->usergroups in the $accessinfo parameter
668      *    to execute_query (ideally, using these to automatically restrict search results).
669      * 2. Support the optional groupids parameter in the $filter parameter for execute_query to
670      *    restrict results to only those where the stored groupid matches the given value.
671      *
672      * @return bool True if this engine supports searching by group id field
673      */
674     public function supports_group_filtering() {
675         return false;
676     }
678     /**
679      * Obtain a list of results orders (and names for them) that are supported by this
680      * search engine in the given context.
681      *
682      * By default, engines sort by relevance only.
683      *
684      * @param \context $context Context that the user requested search from
685      * @return array Array from order name => display text
686      */
687     public function get_supported_orders(\context $context) {
688         return ['relevance' => get_string('order_relevance', 'search')];
689     }
691     /**
692      * Checks if the search engine supports searching by user.
693      *
694      * If it returns true to this function, the search engine should support the 'userids' option
695      * in the $filters value passed to execute_query(), returning only items where the userid in
696      * the search document matches one of those user ids.
697      *
698      * @return bool True if the search engine supports searching by user
699      */
700     public function supports_users() {
701         return false;
702     }
704     /**
705      * Checks if the search engine supports adding documents in a batch.
706      *
707      * If it returns true to this function, the search engine must implement the add_document_batch
708      * function.
709      *
710      * @return bool True if the search engine supports adding documents in a batch
711      */
712     public function supports_add_document_batch(): bool {
713         return false;
714     }
716     /**
717      * Gets the maximum number of documents to send together in batch mode.
718      *
719      * Only relevant if the engine returns true to {@see supports_add_document_batch}.
720      *
721      * Can be overridden by search engine if required.
722      *
723      * @var int Number of documents to send together in batch mode, default 100.
724      */
725     public function get_batch_max_documents(): int {
726         return 100;
727     }
729     /**
730      * Gets the maximum size of document content to be included in a shared batch (if the
731      * document is bigger then it will be sent on its own; batching does not provide a performance
732      * improvement for big documents anyway).
733      *
734      * Only relevant if the engine returns true to {@see supports_add_document_batch}.
735      *
736      * Can be overridden by search engine if required.
737      *
738      * @return int Max size in bytes, default 1MB
739      */
740     public function get_batch_max_content(): int {
741         return 1024 * 1024;
742     }