0ce1d84d74d03d3eb0bebf28dea1f1ccdd613c24
[moodle.git] / search / classes / manager.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  * Search subsystem manager.
19  *
20  * @package   core_search
21  * @copyright Prateek Sachan {@link http://prateeksachan.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_search;
27 defined('MOODLE_INTERNAL') || die;
29 require_once($CFG->dirroot . '/lib/accesslib.php');
31 /**
32  * Search subsystem manager.
33  *
34  * @package   core_search
35  * @copyright Prateek Sachan {@link http://prateeksachan.com}
36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class manager {
40     /**
41      * @var int Text contents.
42      */
43     const TYPE_TEXT = 1;
45     /**
46      * @var int File contents.
47      */
48     const TYPE_FILE = 2;
50     /**
51      * @var int User can not access the document.
52      */
53     const ACCESS_DENIED = 0;
55     /**
56      * @var int User can access the document.
57      */
58     const ACCESS_GRANTED = 1;
60     /**
61      * @var int The document was deleted.
62      */
63     const ACCESS_DELETED = 2;
65     /**
66      * @var int Maximum number of results that will be retrieved from the search engine.
67      */
68     const MAX_RESULTS = 100;
70     /**
71      * @var int Number of results per page.
72      */
73     const DISPLAY_RESULTS_PER_PAGE = 10;
75     /**
76      * @var int The id to be placed in owneruserid when there is no owner.
77      */
78     const NO_OWNER_ID = 0;
80     /**
81      * @var \core_search\base[] Enabled search areas.
82      */
83     protected static $enabledsearchareas = null;
85     /**
86      * @var \core_search\base[] All system search areas.
87      */
88     protected static $allsearchareas = null;
90     /**
91      * @var \core_search\manager
92      */
93     protected static $instance = null;
95     /**
96      * @var \core_search\engine
97      */
98     protected $engine = null;
100     /**
101      * Constructor, use \core_search\manager::instance instead to get a class instance.
102      *
103      * @param \core_search\base The search engine to use
104      */
105     public function __construct($engine) {
106         $this->engine = $engine;
107     }
109     /**
110      * Returns an initialised \core_search instance.
111      *
112      * @see \core_search\engine::is_installed
113      * @see \core_search\engine::is_server_ready
114      * @throws \core_search\engine_exception
115      * @return \core_search\manager
116      */
117     public static function instance() {
118         global $CFG;
120         // One per request, this should be purged during testing.
121         if (static::$instance !== null) {
122             return static::$instance;
123         }
125         if (empty($CFG->searchengine)) {
126             throw new \core_search\engine_exception('enginenotselected', 'search');
127         }
129         if (!$engine = static::search_engine_instance()) {
130             throw new \core_search\engine_exception('enginenotfound', 'search', '', $CFG->searchengine);
131         }
133         if (!$engine->is_installed()) {
134             throw new \core_search\engine_exception('enginenotinstalled', 'search', '', $CFG->searchengine);
135         }
137         $serverstatus = $engine->is_server_ready();
138         if ($serverstatus !== true) {
139             // Error message with no details as this is an exception that any user may find if the server crashes.
140             throw new \core_search\engine_exception('engineserverstatus', 'search');
141         }
143         static::$instance = new \core_search\manager($engine);
144         return static::$instance;
145     }
147     /**
148      * Returns whether global search is enabled or not.
149      *
150      * @return bool
151      */
152     public static function is_global_search_enabled() {
153         global $CFG;
154         return !empty($CFG->enableglobalsearch);
155     }
157     /**
158      * Returns an instance of the search engine.
159      *
160      * @return \core_search\engine
161      */
162     public static function search_engine_instance() {
163         global $CFG;
165         $classname = '\\search_' . $CFG->searchengine . '\\engine';
166         if (!class_exists($classname)) {
167             return false;
168         }
170         return new $classname();
171     }
173     /**
174      * Returns the search engine.
175      *
176      * @return \core_search\engine
177      */
178     public function get_engine() {
179         return $this->engine;
180     }
182     /**
183      * Returns a search area class name.
184      *
185      * @param string $areaid
186      * @return string
187      */
188     protected static function get_area_classname($areaid) {
189         list($componentname, $areaname) = static::extract_areaid_parts($areaid);
190         return '\\' . $componentname . '\\search\\' . $areaname;
191     }
193     /**
194      * Returns a new area search indexer instance.
195      *
196      * @param string $areaid
197      * @return \core_search\base|bool False if the area is not available.
198      */
199     public static function get_search_area($areaid) {
201         // We have them all here.
202         if (!empty(static::$allsearchareas[$areaid])) {
203             return static::$allsearchareas[$areaid];
204         }
206         $classname = static::get_area_classname($areaid);
208         if (class_exists($classname) && static::is_search_area($classname)) {
209             return new $classname();
210         }
212         return false;
213     }
215     /**
216      * Return the list of available search areas.
217      *
218      * @param bool $enabled Return only the enabled ones.
219      * @return \core_search\base[]
220      */
221     public static function get_search_areas_list($enabled = false) {
223         // Two different arrays, we don't expect these arrays to be big.
224         if (static::$allsearchareas !== null) {
225             if (!$enabled) {
226                 return static::$allsearchareas;
227             } else {
228                 return static::$enabledsearchareas;
229             }
230         }
232         static::$allsearchareas = array();
233         static::$enabledsearchareas = array();
235         $plugintypes = \core_component::get_plugin_types();
236         foreach ($plugintypes as $plugintype => $unused) {
237             $plugins = \core_component::get_plugin_list($plugintype);
238             foreach ($plugins as $pluginname => $pluginfullpath) {
240                 $componentname = $plugintype . '_' . $pluginname;
241                 $searchclasses = \core_component::get_component_classes_in_namespace($componentname, 'search');
242                 foreach ($searchclasses as $classname => $classpath) {
243                     $areaname = substr(strrchr($classname, '\\'), 1);
245                     if (!static::is_search_area($classname)) {
246                         continue;
247                     }
249                     $areaid = static::generate_areaid($componentname, $areaname);
250                     $searchclass = new $classname();
252                     static::$allsearchareas[$areaid] = $searchclass;
253                     if ($searchclass->is_enabled()) {
254                         static::$enabledsearchareas[$areaid] = $searchclass;
255                     }
256                 }
257             }
258         }
260         $subsystems = \core_component::get_core_subsystems();
261         foreach ($subsystems as $subsystemname => $subsystempath) {
262             $componentname = 'core_' . $subsystemname;
263             $searchclasses = \core_component::get_component_classes_in_namespace($componentname, 'search');
265             foreach ($searchclasses as $classname => $classpath) {
266                 $areaname = substr(strrchr($classname, '\\'), 1);
268                 if (!static::is_search_area($classname)) {
269                     continue;
270                 }
272                 $areaid = static::generate_areaid($componentname, $areaname);
273                 $searchclass = new $classname();
274                 static::$allsearchareas[$areaid] = $searchclass;
275                 if ($searchclass->is_enabled()) {
276                     static::$enabledsearchareas[$areaid] = $searchclass;
277                 }
278             }
279         }
281         if ($enabled) {
282             return static::$enabledsearchareas;
283         }
284         return static::$allsearchareas;
285     }
287     /**
288      * Clears all static caches.
289      *
290      * @return void
291      */
292     public static function clear_static() {
294         static::$enabledsearchareas = null;
295         static::$allsearchareas = null;
296         static::$instance = null;
298         base_block::clear_static();
299     }
301     /**
302      * Generates an area id from the componentname and the area name.
303      *
304      * There should not be any naming conflict as the area name is the
305      * class name in component/classes/search/.
306      *
307      * @param string $componentname
308      * @param string $areaname
309      * @return void
310      */
311     public static function generate_areaid($componentname, $areaname) {
312         return $componentname . '-' . $areaname;
313     }
315     /**
316      * Returns all areaid string components (component name and area name).
317      *
318      * @param string $areaid
319      * @return array Component name (Frankenstyle) and area name (search area class name)
320      */
321     public static function extract_areaid_parts($areaid) {
322         return explode('-', $areaid);
323     }
325     /**
326      * Returns the contexts the user can access.
327      *
328      * The returned value is a multidimensional array because some search engines can group
329      * information and there will be a performance benefit on passing only some contexts
330      * instead of the whole context array set.
331      *
332      * @param array|false $limitcourseids An array of course ids to limit the search to. False for no limiting.
333      * @return bool|array Indexed by area identifier (component + area name). Returns true if the user can see everything.
334      */
335     protected function get_areas_user_accesses($limitcourseids = false) {
336         global $DB, $USER;
338         // All results for admins. Eventually we could add a new capability for managers.
339         if (is_siteadmin()) {
340             return true;
341         }
343         $areasbylevel = array();
345         // Split areas by context level so we only iterate only once through courses and cms.
346         $searchareas = static::get_search_areas_list(true);
347         foreach ($searchareas as $areaid => $unused) {
348             $classname = static::get_area_classname($areaid);
349             $searcharea = new $classname();
350             foreach ($classname::get_levels() as $level) {
351                 $areasbylevel[$level][$areaid] = $searcharea;
352             }
353         }
355         // This will store area - allowed contexts relations.
356         $areascontexts = array();
358         if (empty($limitcourseids) && !empty($areasbylevel[CONTEXT_SYSTEM])) {
359             // We add system context to all search areas working at this level. Here each area is fully responsible of
360             // the access control as we can not automate much, we can not even check guest access as some areas might
361             // want to allow guests to retrieve data from them.
363             $systemcontextid = \context_system::instance()->id;
364             foreach ($areasbylevel[CONTEXT_SYSTEM] as $areaid => $searchclass) {
365                 $areascontexts[$areaid][$systemcontextid] = $systemcontextid;
366             }
367         }
369         if (!empty($areasbylevel[CONTEXT_USER])) {
370             if ($usercontext = \context_user::instance($USER->id, IGNORE_MISSING)) {
371                 // Extra checking although only logged users should reach this point, guest users have a valid context id.
372                 foreach ($areasbylevel[CONTEXT_USER] as $areaid => $searchclass) {
373                     $areascontexts[$areaid][$usercontext->id] = $usercontext->id;
374                 }
375             }
376         }
378         // Get the courses where the current user has access.
379         $courses = enrol_get_my_courses(array('id', 'cacherev'));
381         if (empty($limitcourseids) || in_array(SITEID, $limitcourseids)) {
382             $courses[SITEID] = get_course(SITEID);
383         }
385         // Keep a list of included course context ids (needed for the block calculation below).
386         $coursecontextids = [];
388         foreach ($courses as $course) {
389             if (!empty($limitcourseids) && !in_array($course->id, $limitcourseids)) {
390                 // Skip non-included courses.
391                 continue;
392             }
394             $coursecontext = \context_course::instance($course->id);
395             $coursecontextids[] = $coursecontext->id;
397             // Info about the course modules.
398             $modinfo = get_fast_modinfo($course);
400             if (!empty($areasbylevel[CONTEXT_COURSE])) {
401                 // Add the course contexts the user can view.
402                 foreach ($areasbylevel[CONTEXT_COURSE] as $areaid => $searchclass) {
403                     if ($course->visible || has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
404                         $areascontexts[$areaid][$coursecontext->id] = $coursecontext->id;
405                     }
406                 }
407             }
409             if (!empty($areasbylevel[CONTEXT_MODULE])) {
410                 // Add the module contexts the user can view (cm_info->uservisible).
412                 foreach ($areasbylevel[CONTEXT_MODULE] as $areaid => $searchclass) {
414                     // Removing the plugintype 'mod_' prefix.
415                     $modulename = substr($searchclass->get_component_name(), 4);
417                     $modinstances = $modinfo->get_instances_of($modulename);
418                     foreach ($modinstances as $modinstance) {
419                         if ($modinstance->uservisible) {
420                             $areascontexts[$areaid][$modinstance->context->id] = $modinstance->context->id;
421                         }
422                     }
423                 }
424             }
425         }
427         // Add all supported block contexts, in a single query for performance.
428         if (!empty($areasbylevel[CONTEXT_BLOCK])) {
429             // Get list of all block types we care about.
430             $blocklist = [];
431             foreach ($areasbylevel[CONTEXT_BLOCK] as $areaid => $searchclass) {
432                 $blocklist[$searchclass->get_block_name()] = true;
433             }
434             list ($blocknamesql, $blocknameparams) = $DB->get_in_or_equal(array_keys($blocklist));
436             // Get list of course contexts.
437             list ($contextsql, $contextparams) = $DB->get_in_or_equal($coursecontextids);
439             // Query all blocks that are within an included course, and are set to be visible, and
440             // in a supported page type (basically just course view). This query could be
441             // extended (or a second query added) to support blocks that are within a module
442             // context as well, and we could add more page types if required.
443             $blockrecs = $DB->get_records_sql("
444                         SELECT x.*, bi.blockname AS blockname, bi.id AS blockinstanceid
445                           FROM {block_instances} bi
446                           JOIN {context} x ON x.instanceid = bi.id AND x.contextlevel = ?
447                      LEFT JOIN {block_positions} bp ON bp.blockinstanceid = bi.id
448                                AND bp.contextid = bi.parentcontextid
449                                AND bp.pagetype LIKE 'course-view-%'
450                                AND bp.subpage = ''
451                                AND bp.visible = 0
452                          WHERE bi.parentcontextid $contextsql
453                                AND bi.blockname $blocknamesql
454                                AND bi.subpagepattern IS NULL
455                                AND (bi.pagetypepattern = 'site-index'
456                                    OR bi.pagetypepattern LIKE 'course-view-%'
457                                    OR bi.pagetypepattern = 'course-*'
458                                    OR bi.pagetypepattern = '*')
459                                AND bp.id IS NULL",
460                     array_merge([CONTEXT_BLOCK], $contextparams, $blocknameparams));
461             $blockcontextsbyname = [];
462             foreach ($blockrecs as $blockrec) {
463                 if (empty($blockcontextsbyname[$blockrec->blockname])) {
464                     $blockcontextsbyname[$blockrec->blockname] = [];
465                 }
466                 \context_helper::preload_from_record($blockrec);
467                 $blockcontextsbyname[$blockrec->blockname][] = \context_block::instance(
468                         $blockrec->blockinstanceid);
469             }
471             // Add the block contexts the user can view.
472             foreach ($areasbylevel[CONTEXT_BLOCK] as $areaid => $searchclass) {
473                 if (empty($blockcontextsbyname[$searchclass->get_block_name()])) {
474                     continue;
475                 }
476                 foreach ($blockcontextsbyname[$searchclass->get_block_name()] as $context) {
477                     if (has_capability('moodle/block:view', $context)) {
478                         $areascontexts[$areaid][$context->id] = $context->id;
479                     }
480                 }
481             }
482         }
484         return $areascontexts;
485     }
487     /**
488      * Returns requested page of documents plus additional information for paging.
489      *
490      * This function does not perform any kind of security checking for access, the caller code
491      * should check that the current user have moodle/search:query capability.
492      *
493      * If a page is requested that is beyond the last result, the last valid page is returned in
494      * results, and actualpage indicates which page was returned.
495      *
496      * @param stdClass $formdata
497      * @param int $pagenum The 0 based page number.
498      * @return object An object with 3 properties:
499      *                    results    => An array of \core_search\documents for the actual page.
500      *                    totalcount => Number of records that are possibly available, to base paging on.
501      *                    actualpage => The actual page returned.
502      */
503     public function paged_search(\stdClass $formdata, $pagenum) {
504         $out = new \stdClass();
506         $perpage = static::DISPLAY_RESULTS_PER_PAGE;
508         // Make sure we only allow request up to max page.
509         $pagenum = min($pagenum, (static::MAX_RESULTS / $perpage) - 1);
511         // Calculate the first and last document number for the current page, 1 based.
512         $mindoc = ($pagenum * $perpage) + 1;
513         $maxdoc = ($pagenum + 1) * $perpage;
515         // Get engine documents, up to max.
516         $docs = $this->search($formdata, $maxdoc);
518         $resultcount = count($docs);
519         if ($resultcount < $maxdoc) {
520             // This means it couldn't give us results to max, so the count must be the max.
521             $out->totalcount = $resultcount;
522         } else {
523             // Get the possible count reported by engine, and limit to our max.
524             $out->totalcount = $this->engine->get_query_total_count();
525             $out->totalcount = min($out->totalcount, static::MAX_RESULTS);
526         }
528         // Determine the actual page.
529         if ($resultcount < $mindoc) {
530             // We couldn't get the min docs for this page, so determine what page we can get.
531             $out->actualpage = floor(($resultcount - 1) / $perpage);
532         } else {
533             $out->actualpage = $pagenum;
534         }
536         // Split the results to only return the page.
537         $out->results = array_slice($docs, $out->actualpage * $perpage, $perpage, true);
539         return $out;
540     }
542     /**
543      * Returns documents from the engine based on the data provided.
544      *
545      * This function does not perform any kind of security checking, the caller code
546      * should check that the current user have moodle/search:query capability.
547      *
548      * It might return the results from the cache instead.
549      *
550      * @param stdClass $formdata
551      * @param int      $limit The maximum number of documents to return
552      * @return \core_search\document[]
553      */
554     public function search(\stdClass $formdata, $limit = 0) {
555         global $USER;
557         $limitcourseids = false;
558         if (!empty($formdata->courseids)) {
559             $limitcourseids = $formdata->courseids;
560         }
562         // Clears previous query errors.
563         $this->engine->clear_query_error();
565         $areascontexts = $this->get_areas_user_accesses($limitcourseids);
566         if (!$areascontexts) {
567             // User can not access any context.
568             $docs = array();
569         } else {
570             $docs = $this->engine->execute_query($formdata, $areascontexts, $limit);
571         }
573         return $docs;
574     }
576     /**
577      * Merge separate index segments into one.
578      */
579     public function optimize_index() {
580         $this->engine->optimize();
581     }
583     /**
584      * Index all documents.
585      *
586      * @param bool $fullindex Whether we should reindex everything or not.
587      * @param float $timelimit Time limit in seconds (0 = no time limit)
588      * @param \progress_trace $progress Optional class for tracking progress
589      * @throws \moodle_exception
590      * @return bool Whether there was any updated document or not.
591      */
592     public function index($fullindex = false, $timelimit = 0, \progress_trace $progress = null) {
593         // Cannot combine time limit with reindex.
594         if ($timelimit && $fullindex) {
595             throw new \coding_exception('Cannot apply time limit when reindexing');
596         }
597         if (!$progress) {
598             $progress = new \null_progress_trace();
599         }
601         // Unlimited time.
602         \core_php_time_limit::raise();
604         // Notify the engine that an index starting.
605         $this->engine->index_starting($fullindex);
607         $sumdocs = 0;
609         $searchareas = $this->get_search_areas_list(true);
611         if ($timelimit) {
612             // If time is limited (and therefore we're not just indexing everything anyway), select
613             // an order for search areas. The intention here is to avoid a situation where a new
614             // large search area is enabled, and this means all our other search areas go out of
615             // date while that one is being indexed. To do this, we order by the time we spent
616             // indexing them last time we ran, meaning anything that took a very long time will be
617             // done last.
618             uasort($searchareas, function(\core_search\base $area1, \core_search\base $area2) {
619                 return (int)$area1->get_last_indexing_duration() - (int)$area2->get_last_indexing_duration();
620             });
622             // Decide time to stop.
623             $stopat = microtime(true) + $timelimit;
624         }
626         foreach ($searchareas as $areaid => $searcharea) {
628             $progress->output('Processing area: ' . $searcharea->get_visible_name());
630             // Notify the engine that an area is starting.
631             $this->engine->area_index_starting($searcharea, $fullindex);
633             $indexingstart = time();
634             $elapsed = microtime(true);
636             // This is used to store this component config.
637             list($componentconfigname, $varname) = $searcharea->get_config_var_name();
639             $prevtimestart = intval(get_config($componentconfigname, $varname . '_indexingstart'));
641             if ($fullindex === true) {
642                 $referencestarttime = 0;
643             } else {
644                 $partial = get_config($componentconfigname, $varname . '_partial');
645                 if ($partial) {
646                     // When the previous index did not complete all data, we start from the time of the
647                     // last document that was successfully indexed. (Note this will result in
648                     // re-indexing that one document, but we can't avoid that because there may be
649                     // other documents in the same second.)
650                     $referencestarttime = intval(get_config($componentconfigname, $varname . '_lastindexrun'));
651                 } else {
652                     $referencestarttime = $prevtimestart;
653                 }
654             }
656             // Getting the recordset from the area.
657             $recordset = $searcharea->get_recordset_by_timestamp($referencestarttime);
659             // Pass get_document as callback.
660             $fileindexing = $this->engine->file_indexing_enabled() && $searcharea->uses_file_indexing();
661             $options = array('indexfiles' => $fileindexing, 'lastindexedtime' => $prevtimestart);
662             if ($timelimit) {
663                 $options['stopat'] = $stopat;
664             }
665             $iterator = new \core\dml\recordset_walk($recordset, array($searcharea, 'get_document'), $options);
666             $result = $this->engine->add_documents($iterator, $searcharea, $options);
667             if (count($result) === 5) {
668                 list($numrecords, $numdocs, $numdocsignored, $lastindexeddoc, $partial) = $result;
669             } else {
670                 // Backward compatibility for engines that don't support partial adding.
671                 list($numrecords, $numdocs, $numdocsignored, $lastindexeddoc) = $result;
672                 debugging('engine::add_documents() should return $partial (4-value return is deprecated)',
673                         DEBUG_DEVELOPER);
674                 $partial = false;
675             }
677             if ($numdocs > 0) {
678                 $elapsed = round((microtime(true) - $elapsed), 3);
679                 $progress->output('Processed ' . $numrecords . ' records containing ' . $numdocs .
680                         ' documents, in ' . $elapsed . ' seconds' .
681                         ($partial ? ' (not complete)' : '') . '.', 1);
682             } else {
683                 $progress->output('No new documents to index.', 1);
684             }
686             // Notify the engine this area is complete, and only mark times if true.
687             if ($this->engine->area_index_complete($searcharea, $numdocs, $fullindex)) {
688                 $sumdocs += $numdocs;
690                 // Store last index run once documents have been committed to the search engine.
691                 set_config($varname . '_indexingstart', $indexingstart, $componentconfigname);
692                 set_config($varname . '_indexingend', time(), $componentconfigname);
693                 set_config($varname . '_docsignored', $numdocsignored, $componentconfigname);
694                 set_config($varname . '_docsprocessed', $numdocs, $componentconfigname);
695                 set_config($varname . '_recordsprocessed', $numrecords, $componentconfigname);
696                 if ($lastindexeddoc > 0) {
697                     set_config($varname . '_lastindexrun', $lastindexeddoc, $componentconfigname);
698                 }
699                 if ($partial) {
700                     set_config($varname . '_partial', 1, $componentconfigname);
701                 } else {
702                     unset_config($varname . '_partial', $componentconfigname);
703                 }
704             } else {
705                 $progress->output('Engine reported error.');
706             }
708             if ($timelimit && (microtime(true) >= $stopat)) {
709                 $progress->output('Stopping indexing due to time limit.');
710                 break;
711             }
712         }
714         if ($sumdocs > 0) {
715             $event = \core\event\search_indexed::create(
716                     array('context' => \context_system::instance()));
717             $event->trigger();
718         }
720         $this->engine->index_complete($sumdocs, $fullindex);
722         return (bool)$sumdocs;
723     }
725     /**
726      * Resets areas config.
727      *
728      * @throws \moodle_exception
729      * @param string $areaid
730      * @return void
731      */
732     public function reset_config($areaid = false) {
734         if (!empty($areaid)) {
735             $searchareas = array();
736             if (!$searchareas[$areaid] = static::get_search_area($areaid)) {
737                 throw new \moodle_exception('errorareanotavailable', 'search', '', $areaid);
738             }
739         } else {
740             // Only the enabled ones.
741             $searchareas = static::get_search_areas_list(true);
742         }
744         foreach ($searchareas as $searcharea) {
745             list($componentname, $varname) = $searcharea->get_config_var_name();
746             $config = $searcharea->get_config();
748             foreach ($config as $key => $value) {
749                 // We reset them all but the enable/disabled one.
750                 if ($key !== $varname . '_enabled') {
751                     set_config($key, 0, $componentname);
752                 }
753             }
754         }
755     }
757     /**
758      * Deletes an area's documents or all areas documents.
759      *
760      * @param string $areaid The area id or false for all
761      * @return void
762      */
763     public function delete_index($areaid = false) {
764         if (!empty($areaid)) {
765             $this->engine->delete($areaid);
766             $this->reset_config($areaid);
767         } else {
768             $this->engine->delete();
769             $this->reset_config();
770         }
771     }
773     /**
774      * Deletes index by id.
775      *
776      * @param int Solr Document string $id
777      */
778     public function delete_index_by_id($id) {
779         $this->engine->delete_by_id($id);
780     }
782     /**
783      * Returns search areas configuration.
784      *
785      * @param \core_search\base[] $searchareas
786      * @return \stdClass[] $configsettings
787      */
788     public function get_areas_config($searchareas) {
790         $vars = array('indexingstart', 'indexingend', 'lastindexrun', 'docsignored',
791                 'docsprocessed', 'recordsprocessed', 'partial');
793         $configsettings = [];
794         foreach ($searchareas as $searcharea) {
796             $areaid = $searcharea->get_area_id();
798             $configsettings[$areaid] = new \stdClass();
799             list($componentname, $varname) = $searcharea->get_config_var_name();
801             if (!$searcharea->is_enabled()) {
802                 // We delete all indexed data on disable so no info.
803                 foreach ($vars as $var) {
804                     $configsettings[$areaid]->{$var} = 0;
805                 }
806             } else {
807                 foreach ($vars as $var) {
808                     $configsettings[$areaid]->{$var} = get_config($componentname, $varname .'_' . $var);
809                 }
810             }
812             // Formatting the time.
813             if (!empty($configsettings[$areaid]->lastindexrun)) {
814                 $configsettings[$areaid]->lastindexrun = userdate($configsettings[$areaid]->lastindexrun);
815             } else {
816                 $configsettings[$areaid]->lastindexrun = get_string('never');
817             }
818         }
819         return $configsettings;
820     }
822     /**
823      * Triggers search_results_viewed event
824      *
825      * Other data required:
826      * - q: The query string
827      * - page: The page number
828      * - title: Title filter
829      * - areaids: Search areas filter
830      * - courseids: Courses filter
831      * - timestart: Time start filter
832      * - timeend: Time end filter
833      *
834      * @since Moodle 3.2
835      * @param array $other Other info for the event.
836      * @return \core\event\search_results_viewed
837      */
838     public static function trigger_search_results_viewed($other) {
839         $event = \core\event\search_results_viewed::create([
840             'context' => \context_system::instance(),
841             'other' => $other
842         ]);
843         $event->trigger();
845         return $event;
846     }
848     /**
849      * Checks whether a classname is of an actual search area.
850      *
851      * @param string $classname
852      * @return bool
853      */
854     protected static function is_search_area($classname) {
855         if (is_subclass_of($classname, 'core_search\base')) {
856             return (new \ReflectionClass($classname))->isInstantiable();
857         }
859         return false;
860     }