MDL-68334 user: Display name in footer as elsewhere.
[moodle.git] / search / engine / solr / 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  * Solr engine.
19  *
20  * @package    search_solr
21  * @copyright  2015 Daniel Neis Araujo
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace search_solr;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Solr engine.
31  *
32  * @package    search_solr
33  * @copyright  2015 Daniel Neis Araujo
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class engine extends \core_search\engine {
38     /**
39      * @var string The date format used by solr.
40      */
41     const DATE_FORMAT = 'Y-m-d\TH:i:s\Z';
43     /**
44      * @var int Commit documents interval (number of miliseconds).
45      */
46     const AUTOCOMMIT_WITHIN = 15000;
48     /**
49      * The maximum number of results to fetch at a time.
50      */
51     const QUERY_SIZE = 120;
53     /**
54      * Highlighting fragsize. Slightly larger than output size (500) to allow for ... appending.
55      */
56     const FRAG_SIZE = 510;
58     /**
59      * Marker for the start of a highlight.
60      */
61     const HIGHLIGHT_START = '@@HI_S@@';
63     /**
64      * Marker for the end of a highlight.
65      */
66     const HIGHLIGHT_END = '@@HI_E@@';
68     /** @var float Boost value for matching course in location-ordered searches */
69     const COURSE_BOOST = 1;
71     /** @var float Boost value for matching context (in addition to course boost) */
72     const CONTEXT_BOOST = 0.5;
74     /**
75      * @var \SolrClient
76      */
77     protected $client = null;
79     /**
80      * @var bool True if we should reuse SolrClients, false if not.
81      */
82     protected $cacheclient = true;
84     /**
85      * @var \curl Direct curl object.
86      */
87     protected $curl = null;
89     /**
90      * @var array Fields that can be highlighted.
91      */
92     protected $highlightfields = array('title', 'content', 'description1', 'description2');
94     /**
95      * @var int Number of total docs reported by Sorl for the last query.
96      */
97     protected $totalenginedocs = 0;
99     /**
100      * @var int Number of docs we have processed for the last query.
101      */
102     protected $processeddocs = 0;
104     /**
105      * @var int Number of docs that have been skipped while processing the last query.
106      */
107     protected $skippeddocs = 0;
109     /**
110      * Solr server major version.
111      *
112      * @var int
113      */
114     protected $solrmajorversion = null;
116     /**
117      * Initialises the search engine configuration.
118      *
119      * @return void
120      */
121     public function __construct() {
122         parent::__construct();
124         $curlversion = curl_version();
125         if (isset($curlversion['version']) && stripos($curlversion['version'], '7.35.') === 0) {
126             // There is a flaw with curl 7.35.0 that causes problems with client reuse.
127             $this->cacheclient = false;
128         }
129     }
131     /**
132      * Prepares a Solr query, applies filters and executes it returning its results.
133      *
134      * @throws \core_search\engine_exception
135      * @param  \stdClass $filters Containing query and filters.
136      * @param  \stdClass $accessinfo Information about areas user can access.
137      * @param  int       $limit The maximum number of results to return.
138      * @return \core_search\document[] Results or false if no results
139      */
140     public function execute_query($filters, $accessinfo, $limit = 0) {
141         global $USER;
143         if (empty($limit)) {
144             $limit = \core_search\manager::MAX_RESULTS;
145         }
147         // If there is any problem we trigger the exception as soon as possible.
148         $client = $this->get_search_client();
150         // Create the query object.
151         $query = $this->create_user_query($filters, $accessinfo);
153         // If the query cannot have results, return none.
154         if (!$query) {
155             return [];
156         }
158         // We expect good match rates, so for our first get, we will get a small number of records.
159         // This significantly speeds solr response time for first few pages.
160         $query->setRows(min($limit * 3, static::QUERY_SIZE));
161         $response = $this->get_query_response($query);
163         // Get count data out of the response, and reset our counters.
164         list($included, $found) = $this->get_response_counts($response);
165         $this->totalenginedocs = $found;
166         $this->processeddocs = 0;
167         $this->skippeddocs = 0;
168         if ($included == 0 || $this->totalenginedocs == 0) {
169             // No results.
170             return array();
171         }
173         // Get valid documents out of the response.
174         $results = $this->process_response($response, $limit);
176         // We have processed all the docs in the response at this point.
177         $this->processeddocs += $included;
179         // If we haven't reached the limit, and there are more docs left in Solr, lets keep trying.
180         while (count($results) < $limit && ($this->totalenginedocs - $this->processeddocs) > 0) {
181             // Offset the start of the query, and since we are making another call, get more per call.
182             $query->setStart($this->processeddocs);
183             $query->setRows(static::QUERY_SIZE);
185             $response = $this->get_query_response($query);
186             list($included, $found) = $this->get_response_counts($response);
187             if ($included == 0 || $found == 0) {
188                 // No new results were found. Found being empty would be weird, so we will just return.
189                 return $results;
190             }
191             $this->totalenginedocs = $found;
193             // Get the new response docs, limiting to remaining we need, then add it to the end of the results array.
194             $newdocs = $this->process_response($response, $limit - count($results));
195             $results = array_merge($results, $newdocs);
197             // Add to our processed docs count.
198             $this->processeddocs += $included;
199         }
201         return $results;
202     }
204     /**
205      * Takes a query and returns the response in SolrObject format.
206      *
207      * @param  SolrQuery  $query Solr query object.
208      * @return SolrObject|false Response document or false on error.
209      */
210     protected function get_query_response($query) {
211         try {
212             return $this->get_search_client()->query($query)->getResponse();
213         } catch (\SolrClientException $ex) {
214             debugging('Error executing the provided query: ' . $ex->getMessage(), DEBUG_DEVELOPER);
215             $this->queryerror = $ex->getMessage();
216             return false;
217         } catch (\SolrServerException $ex) {
218             debugging('Error executing the provided query: ' . $ex->getMessage(), DEBUG_DEVELOPER);
219             $this->queryerror = $ex->getMessage();
220             return false;
221         }
222     }
224     /**
225      * Returns the total number of documents available for the most recently call to execute_query.
226      *
227      * @return int
228      */
229     public function get_query_total_count() {
230         // Return the total engine count minus the docs we have determined are bad.
231         return $this->totalenginedocs - $this->skippeddocs;
232     }
234     /**
235      * Returns count information for a provided response. Will return 0, 0 for invalid or empty responses.
236      *
237      * @param SolrDocument $response The response document from Solr.
238      * @return array A two part array. First how many response docs are in the response.
239      *               Second, how many results are vailable in the engine.
240      */
241     protected function get_response_counts($response) {
242         $found = 0;
243         $included = 0;
245         if (isset($response->grouped->solr_filegroupingid->ngroups)) {
246             // Get the number of results for file grouped queries.
247             $found = $response->grouped->solr_filegroupingid->ngroups;
248             $included = count($response->grouped->solr_filegroupingid->groups);
249         } else if (isset($response->response->numFound)) {
250             // Get the number of results for standard queries.
251             $found = $response->response->numFound;
252             if ($found > 0 && is_array($response->response->docs)) {
253                 $included = count($response->response->docs);
254             }
255         }
257         return array($included, $found);
258     }
260     /**
261      * Prepares a new query object with needed limits, filters, etc.
262      *
263      * @param \stdClass $filters Containing query and filters.
264      * @param \stdClass $accessinfo Information about contexts the user can access
265      * @return \SolrDisMaxQuery|null Query object or null if they can't get any results
266      */
267     protected function create_user_query($filters, $accessinfo) {
268         global $USER;
270         // Let's keep these changes internal.
271         $data = clone $filters;
273         $query = new \SolrDisMaxQuery();
275         $this->set_query($query, self::replace_underlines($data->q));
276         $this->add_fields($query);
278         // Search filters applied, we don't cache these filters as we don't want to pollute the cache with tmp filters
279         // we are really interested in caching contexts filters instead.
280         if (!empty($data->title)) {
281             $query->addFilterQuery('{!field cache=false f=title}' . $data->title);
282         }
283         if (!empty($data->areaids)) {
284             // If areaids are specified, we want to get any that match.
285             $query->addFilterQuery('{!cache=false}areaid:(' . implode(' OR ', $data->areaids) . ')');
286         }
287         if (!empty($data->courseids)) {
288             $query->addFilterQuery('{!cache=false}courseid:(' . implode(' OR ', $data->courseids) . ')');
289         }
290         if (!empty($data->groupids)) {
291             $query->addFilterQuery('{!cache=false}groupid:(' . implode(' OR ', $data->groupids) . ')');
292         }
293         if (!empty($data->userids)) {
294             $query->addFilterQuery('{!cache=false}userid:(' . implode(' OR ', $data->userids) . ')');
295         }
297         if (!empty($data->timestart) or !empty($data->timeend)) {
298             if (empty($data->timestart)) {
299                 $data->timestart = '*';
300             } else {
301                 $data->timestart = \search_solr\document::format_time_for_engine($data->timestart);
302             }
303             if (empty($data->timeend)) {
304                 $data->timeend = '*';
305             } else {
306                 $data->timeend = \search_solr\document::format_time_for_engine($data->timeend);
307             }
309             // No cache.
310             $query->addFilterQuery('{!cache=false}modified:[' . $data->timestart . ' TO ' . $data->timeend . ']');
311         }
313         // Restrict to users who are supposed to be able to see a particular result.
314         $query->addFilterQuery('owneruserid:(' . \core_search\manager::NO_OWNER_ID . ' OR ' . $USER->id . ')');
316         // And finally restrict it to the context where the user can access, we want this one cached.
317         // If the user can access all contexts $usercontexts value is just true, we don't need to filter
318         // in that case.
319         if (!$accessinfo->everything && is_array($accessinfo->usercontexts)) {
320             // Join all area contexts into a single array and implode.
321             $allcontexts = array();
322             foreach ($accessinfo->usercontexts as $areaid => $areacontexts) {
323                 if (!empty($data->areaids) && !in_array($areaid, $data->areaids)) {
324                     // Skip unused areas.
325                     continue;
326                 }
327                 foreach ($areacontexts as $contextid) {
328                     // Ensure they are unique.
329                     $allcontexts[$contextid] = $contextid;
330                 }
331             }
332             if (empty($allcontexts)) {
333                 // This means there are no valid contexts for them, so they get no results.
334                 return null;
335             }
336             $query->addFilterQuery('contextid:(' . implode(' OR ', $allcontexts) . ')');
337         }
339         if (!$accessinfo->everything && $accessinfo->separategroupscontexts) {
340             // Add another restriction to handle group ids. If there are any contexts using separate
341             // groups, then results in that context will not show unless you belong to the group.
342             // (Note: Access all groups is taken care of earlier, when computing these arrays.)
344             // This special exceptions list allows for particularly pig-headed developers to create
345             // multiple search areas within the same module, where one of them uses separate
346             // groups and the other uses visible groups. It is a little inefficient, but this should
347             // be rare.
348             $exceptions = '';
349             if ($accessinfo->visiblegroupscontextsareas) {
350                 foreach ($accessinfo->visiblegroupscontextsareas as $contextid => $areaids) {
351                     $exceptions .= ' OR (contextid:' . $contextid . ' AND areaid:(' .
352                             implode(' OR ', $areaids) . '))';
353                 }
354             }
356             if ($accessinfo->usergroups) {
357                 // Either the document has no groupid, or the groupid is one that the user
358                 // belongs to, or the context is not one of the separate groups contexts.
359                 $query->addFilterQuery('(*:* -groupid:[* TO *]) OR ' .
360                         'groupid:(' . implode(' OR ', $accessinfo->usergroups) . ') OR ' .
361                         '(*:* -contextid:(' . implode(' OR ', $accessinfo->separategroupscontexts) . '))' .
362                         $exceptions);
363             } else {
364                 // Either the document has no groupid, or the context is not a restricted one.
365                 $query->addFilterQuery('(*:* -groupid:[* TO *]) OR ' .
366                         '(*:* -contextid:(' . implode(' OR ', $accessinfo->separategroupscontexts) . '))' .
367                         $exceptions);
368             }
369         }
371         if ($this->file_indexing_enabled()) {
372             // Now group records by solr_filegroupingid. Limit to 3 results per group.
373             $query->setGroup(true);
374             $query->setGroupLimit(3);
375             $query->setGroupNGroups(true);
376             $query->addGroupField('solr_filegroupingid');
377         } else {
378             // Make sure we only get text files, in case the index has pre-existing files.
379             $query->addFilterQuery('type:'.\core_search\manager::TYPE_TEXT);
380         }
382         // If ordering by location, add in boost for the relevant course or context ids.
383         if (!empty($filters->order) && $filters->order === 'location') {
384             $coursecontext = $filters->context->get_course_context();
385             $query->addBoostQuery('courseid', $coursecontext->instanceid, self::COURSE_BOOST);
386             if ($filters->context->contextlevel !== CONTEXT_COURSE) {
387                 // If it's a block or activity, also add a boost for the specific context id.
388                 $query->addBoostQuery('contextid', $filters->context->id, self::CONTEXT_BOOST);
389             }
390         }
392         return $query;
393     }
395     /**
396      * Prepares a new query by setting the query, start offset and rows to return.
397      *
398      * @param SolrQuery $query
399      * @param object    $q Containing query and filters.
400      */
401     protected function set_query($query, $q) {
402         // Set hightlighting.
403         $query->setHighlight(true);
404         foreach ($this->highlightfields as $field) {
405             $query->addHighlightField($field);
406         }
407         $query->setHighlightFragsize(static::FRAG_SIZE);
408         $query->setHighlightSimplePre(self::HIGHLIGHT_START);
409         $query->setHighlightSimplePost(self::HIGHLIGHT_END);
410         $query->setHighlightMergeContiguous(true);
412         $query->setQuery($q);
414         // A reasonable max.
415         $query->setRows(static::QUERY_SIZE);
416     }
418     /**
419      * Sets fields to be returned in the result.
420      *
421      * @param SolrDisMaxQuery|SolrQuery $query object.
422      */
423     public function add_fields($query) {
424         $documentclass = $this->get_document_classname();
425         $fields = $documentclass::get_default_fields_definition();
427         $dismax = false;
428         if ($query instanceof \SolrDisMaxQuery) {
429             $dismax = true;
430         }
432         foreach ($fields as $key => $field) {
433             $query->addField($key);
434             if ($dismax && !empty($field['mainquery'])) {
435                 // Add fields the main query should be run against.
436                 // Due to a regression in the PECL solr extension, https://bugs.php.net/bug.php?id=72740,
437                 // a boost value is required, even if it is optional; to avoid boosting one among other fields,
438                 // the explicit boost value will be the default one, for every field.
439                 $query->addQueryField($key, 1);
440             }
441         }
442     }
444     /**
445      * Finds the key common to both highlighing and docs array returned from response.
446      * @param object $response containing results.
447      */
448     public function add_highlight_content($response) {
449         if (!isset($response->highlighting)) {
450             // There is no highlighting to add.
451             return;
452         }
454         $highlightedobject = $response->highlighting;
455         foreach ($response->response->docs as $doc) {
456             $x = $doc->id;
457             $highlighteddoc = $highlightedobject->$x;
458             $this->merge_highlight_field_values($doc, $highlighteddoc);
459         }
460     }
462     /**
463      * Adds the highlighting array values to docs array values.
464      *
465      * @throws \core_search\engine_exception
466      * @param object $doc containing the results.
467      * @param object $highlighteddoc containing the highlighted results values.
468      */
469     public function merge_highlight_field_values($doc, $highlighteddoc) {
471         foreach ($this->highlightfields as $field) {
472             if (!empty($doc->$field)) {
474                 // Check that the returned value is not an array. No way we can make this work with multivalued solr fields.
475                 if (is_array($doc->{$field})) {
476                     throw new \core_search\engine_exception('multivaluedfield', 'search_solr', '', $field);
477                 }
479                 if (!empty($highlighteddoc->$field)) {
480                     // Replace by the highlighted result.
481                     $doc->$field = reset($highlighteddoc->$field);
482                 }
483             }
484         }
485     }
487     /**
488      * Filters the response on Moodle side.
489      *
490      * @param SolrObject $response Solr object containing the response return from solr server.
491      * @param int        $limit The maximum number of results to return. 0 for all.
492      * @param bool       $skipaccesscheck Don't use check_access() on results. Only to be used when results have known access.
493      * @return array $results containing final results to be displayed.
494      */
495     protected function process_response($response, $limit = 0, $skipaccesscheck = false) {
496         global $USER;
498         if (empty($response)) {
499             return array();
500         }
502         if (isset($response->grouped)) {
503             return $this->grouped_files_process_response($response, $limit);
504         }
506         $userid = $USER->id;
507         $noownerid = \core_search\manager::NO_OWNER_ID;
509         $numgranted = 0;
511         if (!$docs = $response->response->docs) {
512             return array();
513         }
515         $out = array();
516         if (!empty($response->response->numFound)) {
517             $this->add_highlight_content($response);
519             // Iterate through the results checking its availability and whether they are available for the user or not.
520             foreach ($docs as $key => $docdata) {
521                 if ($docdata['owneruserid'] != $noownerid && $docdata['owneruserid'] != $userid) {
522                     // If owneruserid is set, no other user should be able to access this record.
523                     continue;
524                 }
526                 if (!$searcharea = $this->get_search_area($docdata->areaid)) {
527                     continue;
528                 }
530                 $docdata = $this->standarize_solr_obj($docdata);
532                 if ($skipaccesscheck) {
533                     $access = \core_search\manager::ACCESS_GRANTED;
534                 } else {
535                     $access = $searcharea->check_access($docdata['itemid']);
536                 }
537                 switch ($access) {
538                     case \core_search\manager::ACCESS_DELETED:
539                         $this->delete_by_id($docdata['id']);
540                         // Remove one from our processed and total counters, since we promptly deleted.
541                         $this->processeddocs--;
542                         $this->totalenginedocs--;
543                         break;
544                     case \core_search\manager::ACCESS_DENIED:
545                         $this->skippeddocs++;
546                         break;
547                     case \core_search\manager::ACCESS_GRANTED:
548                         $numgranted++;
550                         // Add the doc.
551                         $out[] = $this->to_document($searcharea, $docdata);
552                         break;
553                 }
555                 // Stop when we hit our limit.
556                 if (!empty($limit) && count($out) >= $limit) {
557                     break;
558                 }
559             }
560         }
562         return $out;
563     }
565     /**
566      * Processes grouped file results into documents, with attached matching files.
567      *
568      * @param SolrObject $response The response returned from solr server
569      * @param int        $limit The maximum number of results to return. 0 for all.
570      * @return array Final results to be displayed.
571      */
572     protected function grouped_files_process_response($response, $limit = 0) {
573         // If we can't find the grouping, or there are no matches in the grouping, return empty.
574         if (!isset($response->grouped->solr_filegroupingid) || empty($response->grouped->solr_filegroupingid->matches)) {
575             return array();
576         }
578         $numgranted = 0;
579         $orderedids = array();
580         $completedocs = array();
581         $incompletedocs = array();
583         $highlightingobj = $response->highlighting;
585         // Each group represents a "master document".
586         $groups = $response->grouped->solr_filegroupingid->groups;
587         foreach ($groups as $group) {
588             $groupid = $group->groupValue;
589             $groupdocs = $group->doclist->docs;
590             $firstdoc = reset($groupdocs);
592             if (!$searcharea = $this->get_search_area($firstdoc->areaid)) {
593                 // Well, this is a problem.
594                 continue;
595             }
597             // Check for access.
598             $access = $searcharea->check_access($firstdoc->itemid);
599             switch ($access) {
600                 case \core_search\manager::ACCESS_DELETED:
601                     // If deleted from Moodle, delete from index and then continue.
602                     $this->delete_by_id($firstdoc->id);
603                     // Remove one from our processed and total counters, since we promptly deleted.
604                     $this->processeddocs--;
605                     $this->totalenginedocs--;
606                     continue 2;
607                     break;
608                 case \core_search\manager::ACCESS_DENIED:
609                     // This means we should just skip for the current user.
610                     $this->skippeddocs++;
611                     continue 2;
612                     break;
613             }
614             $numgranted++;
616             $maindoc = false;
617             $fileids = array();
618             // Seperate the main document and any files returned.
619             foreach ($groupdocs as $groupdoc) {
620                 if ($groupdoc->id == $groupid) {
621                     $maindoc = $groupdoc;
622                 } else if (isset($groupdoc->solr_fileid)) {
623                     $fileids[] = $groupdoc->solr_fileid;
624                 }
625             }
627             // Store the id of this group, in order, for later merging.
628             $orderedids[] = $groupid;
630             if (!$maindoc) {
631                 // We don't have the main doc, store what we know for later building.
632                 $incompletedocs[$groupid] = $fileids;
633             } else {
634                 if (isset($highlightingobj->$groupid)) {
635                     // Merge the highlighting for this doc.
636                     $this->merge_highlight_field_values($maindoc, $highlightingobj->$groupid);
637                 }
638                 $docdata = $this->standarize_solr_obj($maindoc);
639                 $doc = $this->to_document($searcharea, $docdata);
640                 // Now we need to attach the result files to the doc.
641                 foreach ($fileids as $fileid) {
642                     $doc->add_stored_file($fileid);
643                 }
644                 $completedocs[$groupid] = $doc;
645             }
647             if (!empty($limit) && $numgranted >= $limit) {
648                 // We have hit the max results, we will just ignore the rest.
649                 break;
650             }
651         }
653         $incompletedocs = $this->get_missing_docs($incompletedocs);
655         $out = array();
656         // Now merge the complete and incomplete documents, in results order.
657         foreach ($orderedids as $docid) {
658             if (isset($completedocs[$docid])) {
659                 $out[] = $completedocs[$docid];
660             } else if (isset($incompletedocs[$docid])) {
661                 $out[] = $incompletedocs[$docid];
662             }
663         }
665         return $out;
666     }
668     /**
669      * Retreive any missing main documents and attach provided files.
670      *
671      * The missingdocs array should be an array, indexed by document id, of main documents we need to retrieve. The value
672      * associated to the key should be an array of stored_files or stored file ids to attach to the result document.
673      *
674      * Return array also indexed by document id.
675      *
676      * @param array() $missingdocs An array, indexed by document id, with arrays of files/ids to attach.
677      * @return document[]
678      */
679     protected function get_missing_docs($missingdocs) {
680         if (empty($missingdocs)) {
681             return array();
682         }
684         $docids = array_keys($missingdocs);
686         // Build a custom query that will get all the missing documents.
687         $query = new \SolrQuery();
688         $this->set_query($query, '*');
689         $this->add_fields($query);
690         $query->setRows(count($docids));
691         $query->addFilterQuery('{!cache=false}id:(' . implode(' OR ', $docids) . ')');
693         $response = $this->get_query_response($query);
694         // We know the missing docs have already been checked for access, so don't recheck.
695         $results = $this->process_response($response, 0, true);
697         $out = array();
698         foreach ($results as $result) {
699             $resultid = $result->get('id');
700             if (!isset($missingdocs[$resultid])) {
701                 // We got a result we didn't expect. Skip it.
702                 continue;
703             }
704             // Attach the files.
705             foreach ($missingdocs[$resultid] as $filedoc) {
706                 $result->add_stored_file($filedoc);
707             }
708             $out[$resultid] = $result;
709         }
711         return $out;
712     }
714     /**
715      * Returns a standard php array from a \SolrObject instance.
716      *
717      * @param \SolrObject $obj
718      * @return array The returned document as an array.
719      */
720     public function standarize_solr_obj(\SolrObject $obj) {
721         $properties = $obj->getPropertyNames();
723         $docdata = array();
724         foreach($properties as $name) {
725             // http://php.net/manual/en/solrobject.getpropertynames.php#98018.
726             $name = trim($name);
727             $docdata[$name] = $obj->offsetGet($name);
728         }
729         return $docdata;
730     }
732     /**
733      * Adds a document to the search engine.
734      *
735      * This does not commit to the search engine.
736      *
737      * @param document $document
738      * @param bool     $fileindexing True if file indexing is to be used
739      * @return bool
740      */
741     public function add_document($document, $fileindexing = false) {
742         $docdata = $document->export_for_engine();
744         if (!$this->add_solr_document($docdata)) {
745             return false;
746         }
748         if ($fileindexing) {
749             // This will take care of updating all attached files in the index.
750             $this->process_document_files($document);
751         }
753         return true;
754     }
756     /**
757      * Adds a batch of documents to the engine at once.
758      *
759      * @param \core_search\document[] $documents Documents to add
760      * @param bool $fileindexing If true, indexes files (these are done one at a time)
761      * @return int[] Array of three elements: successfully processed, failed processed, batch count
762      */
763     public function add_document_batch(array $documents, bool $fileindexing = false): array {
764         $docdatabatch = [];
765         foreach ($documents as $document) {
766             $docdatabatch[] = $document->export_for_engine();
767         }
769         $resultcounts = $this->add_solr_documents($docdatabatch);
771         // Files are processed one document at a time (if there are files it's slow anyway).
772         if ($fileindexing) {
773             foreach ($documents as $document) {
774                 // This will take care of updating all attached files in the index.
775                 $this->process_document_files($document);
776             }
777         }
779         return $resultcounts;
780     }
782     /**
783      * Replaces underlines at edges of words in the content with spaces.
784      *
785      * For example '_frogs_' will become 'frogs', '_frogs and toads_' will become 'frogs and toads',
786      * and 'frogs_and_toads' will be left as 'frogs_and_toads'.
787      *
788      * The reason for this is that for italic content_to_text puts _italic_ underlines at the start
789      * and end of the italicised phrase (not between words). Solr treats underlines as part of the
790      * word, which means that if you search for a word in italic then you can't find it.
791      *
792      * @param string $str String to replace
793      * @return string Replaced string
794      */
795     protected static function replace_underlines(string $str): string {
796         return preg_replace('~\b_|_\b~', '', $str);
797     }
799     /**
800      * Creates a Solr document object.
801      *
802      * @param array $doc Array of document fields
803      * @return \SolrInputDocument Created document
804      */
805     protected function create_solr_document(array $doc): \SolrInputDocument {
806         $solrdoc = new \SolrInputDocument();
808         // Replace underlines in the content with spaces. The reason for this is that for italic
809         // text, content_to_text puts _italic_ underlines. Solr treats underlines as part of the
810         // word, which means that if you search for a word in italic then you can't find it.
811         if (array_key_exists('content', $doc)) {
812             $doc['content'] = self::replace_underlines($doc['content']);
813         }
815         // Set all the fields.
816         foreach ($doc as $field => $value) {
817             $solrdoc->addField($field, $value);
818         }
820         return $solrdoc;
821     }
823     /**
824      * Adds a text document to the search engine.
825      *
826      * @param array $doc
827      * @return bool
828      */
829     protected function add_solr_document($doc) {
830         $solrdoc = $this->create_solr_document($doc);
832         try {
833             $result = $this->get_search_client()->addDocument($solrdoc, true, static::AUTOCOMMIT_WITHIN);
834             return true;
835         } catch (\SolrClientException $e) {
836             debugging('Solr client error adding document with id ' . $doc['id'] . ': ' . $e->getMessage(), DEBUG_DEVELOPER);
837         } catch (\SolrServerException $e) {
838             // We only use the first line of the message, as it's a fully java stacktrace behind it.
839             $msg = strtok($e->getMessage(), "\n");
840             debugging('Solr server error adding document with id ' . $doc['id'] . ': ' . $msg, DEBUG_DEVELOPER);
841         }
843         return false;
844     }
846     /**
847      * Adds multiple text documents to the search engine.
848      *
849      * @param array $docs Array of documents (each an array of fields) to add
850      * @return int[] Array of success, failure, batch count
851      * @throws \core_search\engine_exception
852      */
853     protected function add_solr_documents(array $docs): array {
854         $solrdocs = [];
855         foreach ($docs as $doc) {
856             $solrdocs[] = $this->create_solr_document($doc);
857         }
859         try {
860             // Add documents in a batch and report that they all succeeded.
861             $this->get_search_client()->addDocuments($solrdocs, true, static::AUTOCOMMIT_WITHIN);
862             return [count($solrdocs), 0, 1];
863         } catch (\SolrClientException $e) {
864             // If there is an exception, fall through...
865             $donothing = true;
866         } catch (\SolrServerException $e) {
867             // If there is an exception, fall through...
868             $donothing = true;
869         }
871         // When there is an error, we fall back to adding them individually so that we can report
872         // which document(s) failed. Since it overwrites, adding the successful ones multiple
873         // times won't hurt.
874         $success = 0;
875         $failure = 0;
876         $batches = 0;
877         foreach ($docs as $doc) {
878             $result = $this->add_solr_document($doc);
879             $batches++;
880             if ($result) {
881                 $success++;
882             } else {
883                 $failure++;
884             }
885         }
887         return [$success, $failure, $batches];
888     }
890     /**
891      * Index files attached to the docuemnt, ensuring the index matches the current document files.
892      *
893      * For documents that aren't known to be new, we check the index for existing files.
894      * - New files we will add.
895      * - Existing and unchanged files we will skip.
896      * - File that are in the index but not on the document will be deleted from the index.
897      * - Files that have changed will be re-indexed.
898      *
899      * @param document $document
900      */
901     protected function process_document_files($document) {
902         if (!$this->file_indexing_enabled()) {
903             return;
904         }
906         // Maximum rows to process at a time.
907         $rows = 500;
909         // Get the attached files.
910         $files = $document->get_files();
912         // If this isn't a new document, we need to check the exiting indexed files.
913         if (!$document->get_is_new()) {
914             // We do this progressively, so we can handle lots of files cleanly.
915             list($numfound, $indexedfiles) = $this->get_indexed_files($document, 0, $rows);
916             $count = 0;
917             $idstodelete = array();
919             do {
920                 // Go through each indexed file. We want to not index any stored and unchanged ones, delete any missing ones.
921                 foreach ($indexedfiles as $indexedfile) {
922                     $fileid = $indexedfile->solr_fileid;
924                     if (isset($files[$fileid])) {
925                         // Check for changes that would mean we need to re-index the file. If so, just leave in $files.
926                         // Filelib does not guarantee time modified is updated, so we will check important values.
927                         if ($indexedfile->modified != $files[$fileid]->get_timemodified()) {
928                             continue;
929                         }
930                         if (strcmp($indexedfile->title, $files[$fileid]->get_filename()) !== 0) {
931                             continue;
932                         }
933                         if ($indexedfile->solr_filecontenthash != $files[$fileid]->get_contenthash()) {
934                             continue;
935                         }
936                         if ($indexedfile->solr_fileindexstatus == document::INDEXED_FILE_FALSE &&
937                                 $this->file_is_indexable($files[$fileid])) {
938                             // This means that the last time we indexed this file, filtering blocked it.
939                             // Current settings say it is indexable, so we will allow it to be indexed.
940                             continue;
941                         }
943                         // If the file is already indexed, we can just remove it from the files array and skip it.
944                         unset($files[$fileid]);
945                     } else {
946                         // This means we have found a file that is no longer attached, so we need to delete from the index.
947                         // We do it later, since this is progressive, and it could reorder results.
948                         $idstodelete[] = $indexedfile->id;
949                     }
950                 }
951                 $count += $rows;
953                 if ($count < $numfound) {
954                     // If we haven't hit the total count yet, fetch the next batch.
955                     list($numfound, $indexedfiles) = $this->get_indexed_files($document, $count, $rows);
956                 }
958             } while ($count < $numfound);
960             // Delete files that are no longer attached.
961             foreach ($idstodelete as $id) {
962                 // We directly delete the item using the client, as the engine delete_by_id won't work on file docs.
963                 $this->get_search_client()->deleteById($id);
964             }
965         }
967         // Now we can actually index all the remaining files.
968         foreach ($files as $file) {
969             $this->add_stored_file($document, $file);
970         }
971     }
973     /**
974      * Get the currently indexed files for a particular document, returns the total count, and a subset of files.
975      *
976      * @param document $document
977      * @param int      $start The row to start the results on. Zero indexed.
978      * @param int      $rows The number of rows to fetch
979      * @return array   A two element array, the first is the total number of availble results, the second is an array
980      *                 of documents for the current request.
981      */
982     protected function get_indexed_files($document, $start = 0, $rows = 500) {
983         // Build a custom query that will get any document files that are in our solr_filegroupingid.
984         $query = new \SolrQuery();
986         // We want to get all file records tied to a document.
987         // For efficiency, we are building our own, stripped down, query.
988         $query->setQuery('*');
989         $query->setRows($rows);
990         $query->setStart($start);
991         // We want a consistent sorting.
992         $query->addSortField('id');
994         // We only want the bare minimum of fields.
995         $query->addField('id');
996         $query->addField('modified');
997         $query->addField('title');
998         $query->addField('solr_fileid');
999         $query->addField('solr_filecontenthash');
1000         $query->addField('solr_fileindexstatus');
1002         $query->addFilterQuery('{!cache=false}solr_filegroupingid:(' . $document->get('id') . ')');
1003         $query->addFilterQuery('type:' . \core_search\manager::TYPE_FILE);
1005         $response = $this->get_query_response($query);
1006         if (empty($response->response->numFound)) {
1007             return array(0, array());
1008         }
1010         return array($response->response->numFound, $this->convert_file_results($response));
1011     }
1013     /**
1014      * A very lightweight handler for getting information about already indexed files from a Solr response.
1015      *
1016      * @param SolrObject $responsedoc A Solr response document
1017      * @return stdClass[] An array of objects that contain the basic information for file processing.
1018      */
1019     protected function convert_file_results($responsedoc) {
1020         if (!$docs = $responsedoc->response->docs) {
1021             return array();
1022         }
1024         $out = array();
1026         foreach ($docs as $doc) {
1027             // Copy the bare minimim needed info.
1028             $result = new \stdClass();
1029             $result->id = $doc->id;
1030             $result->modified = document::import_time_from_engine($doc->modified);
1031             $result->title = $doc->title;
1032             $result->solr_fileid = $doc->solr_fileid;
1033             $result->solr_filecontenthash = $doc->solr_filecontenthash;
1034             $result->solr_fileindexstatus = $doc->solr_fileindexstatus;
1035             $out[] = $result;
1036         }
1038         return $out;
1039     }
1041     /**
1042      * Adds a file to the search engine.
1043      *
1044      * Notes about Solr and Tika indexing. We do not send the mime type, only the filename.
1045      * Tika has much better content type detection than Moodle, and we will have many more doc failures
1046      * if we try to send mime types.
1047      *
1048      * @param document $document
1049      * @param \stored_file $storedfile
1050      * @return void
1051      */
1052     protected function add_stored_file($document, $storedfile) {
1053         $filedoc = $document->export_file_for_engine($storedfile);
1055         if (!$this->file_is_indexable($storedfile)) {
1056             // For files that we don't consider indexable, we will still place a reference in the search engine.
1057             $filedoc['solr_fileindexstatus'] = document::INDEXED_FILE_FALSE;
1058             $this->add_solr_document($filedoc);
1059             return;
1060         }
1062         $curl = $this->get_curl_object();
1064         $url = $this->get_connection_url('/update/extract');
1066         // Return results as XML.
1067         $url->param('wt', 'xml');
1069         // This will prevent solr from automatically making fields for every tika output.
1070         $url->param('uprefix', 'ignored_');
1072         // Control how content is captured. This will keep our file content clean of non-important metadata.
1073         $url->param('captureAttr', 'true');
1074         // Move the content to a field for indexing.
1075         $url->param('fmap.content', 'solr_filecontent');
1077         // These are common fields that matches the standard *_point dynamic field and causes an error.
1078         $url->param('fmap.media_white_point', 'ignored_mwp');
1079         $url->param('fmap.media_black_point', 'ignored_mbp');
1081         // Copy each key to the url with literal.
1082         // We place in a temp name then copy back to the true field, which prevents errors or Tika overwriting common field names.
1083         foreach ($filedoc as $key => $value) {
1084             // This will take any fields from tika that match our schema and discard them, so they don't overwrite ours.
1085             $url->param('fmap.'.$key, 'ignored_'.$key);
1086             // Place data in a tmp field.
1087             $url->param('literal.mdltmp_'.$key, $value);
1088             // Then move to the final field.
1089             $url->param('fmap.mdltmp_'.$key, $key);
1090         }
1092         // This sets the true filename for Tika.
1093         $url->param('resource.name', $storedfile->get_filename());
1095         // A giant block of code that is really just error checking around the curl request.
1096         try {
1097             // Now actually do the request.
1098             $result = $curl->post($url->out(false), array('myfile' => $storedfile));
1100             $code = $curl->get_errno();
1101             $info = $curl->get_info();
1103             // Now error handling. It is just informational, since we aren't tracking per file/doc results.
1104             if ($code != 0) {
1105                 // This means an internal cURL error occurred error is in result.
1106                 $message = 'Curl error '.$code.' while indexing file with document id '.$filedoc['id'].': '.$result.'.';
1107                 debugging($message, DEBUG_DEVELOPER);
1108             } else if (isset($info['http_code']) && ($info['http_code'] !== 200)) {
1109                 // Unexpected HTTP response code.
1110                 $message = 'Error while indexing file with document id '.$filedoc['id'];
1111                 // Try to get error message out of msg or title if it exists.
1112                 if (preg_match('|<str [^>]*name="msg"[^>]*>(.*?)</str>|i', $result, $matches)) {
1113                     $message .= ': '.$matches[1];
1114                 } else if (preg_match('|<title[^>]*>([^>]*)</title>|i', $result, $matches)) {
1115                     $message .= ': '.$matches[1];
1116                 }
1117                 // This is a common error, happening whenever a file fails to index for any reason, so we will make it quieter.
1118                 if (CLI_SCRIPT && !PHPUNIT_TEST) {
1119                     mtrace($message);
1120                 }
1121             } else {
1122                 // Check for the expected status field.
1123                 if (preg_match('|<int [^>]*name="status"[^>]*>(\d*)</int>|i', $result, $matches)) {
1124                     // Now check for the expected status of 0, if not, error.
1125                     if ((int)$matches[1] !== 0) {
1126                         $message = 'Unexpected Solr status code '.(int)$matches[1];
1127                         $message .= ' while indexing file with document id '.$filedoc['id'].'.';
1128                         debugging($message, DEBUG_DEVELOPER);
1129                     } else {
1130                         // The document was successfully indexed.
1131                         return;
1132                     }
1133                 } else {
1134                     // We received an unprocessable response.
1135                     $message = 'Unexpected Solr response while indexing file with document id '.$filedoc['id'].': ';
1136                     $message .= strtok($result, "\n");
1137                     debugging($message, DEBUG_DEVELOPER);
1138                 }
1139             }
1140         } catch (\Exception $e) {
1141             // There was an error, but we are not tracking per-file success, so we just continue on.
1142             debugging('Unknown exception while indexing file "'.$storedfile->get_filename().'".', DEBUG_DEVELOPER);
1143         }
1145         // If we get here, the document was not indexed due to an error. So we will index just the base info without the file.
1146         $filedoc['solr_fileindexstatus'] = document::INDEXED_FILE_ERROR;
1147         $this->add_solr_document($filedoc);
1148     }
1150     /**
1151      * Checks to see if a passed file is indexable.
1152      *
1153      * @param \stored_file $file The file to check
1154      * @return bool True if the file can be indexed
1155      */
1156     protected function file_is_indexable($file) {
1157         if (!empty($this->config->maxindexfilekb) && ($file->get_filesize() > ($this->config->maxindexfilekb * 1024))) {
1158             // The file is too big to index.
1159             return false;
1160         }
1162         $mime = $file->get_mimetype();
1164         if ($mime == 'application/vnd.moodle.backup') {
1165             // We don't index Moodle backup files. There is nothing usefully indexable in them.
1166             return false;
1167         }
1169         return true;
1170     }
1172     /**
1173      * Commits all pending changes.
1174      *
1175      * @return void
1176      */
1177     protected function commit() {
1178         $this->get_search_client()->commit();
1179     }
1181     /**
1182      * Do any area cleanup needed, and do anything to confirm contents.
1183      *
1184      * Return false to prevent the search area completed time and stats from being updated.
1185      *
1186      * @param \core_search\base $searcharea The search area that was complete
1187      * @param int $numdocs The number of documents that were added to the index
1188      * @param bool $fullindex True if a full index is being performed
1189      * @return bool True means that data is considered indexed
1190      */
1191     public function area_index_complete($searcharea, $numdocs = 0, $fullindex = false) {
1192         $this->commit();
1194         return true;
1195     }
1197     /**
1198      * Return true if file indexing is supported and enabled. False otherwise.
1199      *
1200      * @return bool
1201      */
1202     public function file_indexing_enabled() {
1203         return (bool)$this->config->fileindexing;
1204     }
1206     /**
1207      * Deletes the specified document.
1208      *
1209      * @param string $id The document id to delete
1210      * @return void
1211      */
1212     public function delete_by_id($id) {
1213         // We need to make sure we delete the item and all related files, which can be done with solr_filegroupingid.
1214         $this->get_search_client()->deleteByQuery('solr_filegroupingid:' . $id);
1215         $this->commit();
1216     }
1218     /**
1219      * Delete all area's documents.
1220      *
1221      * @param string $areaid
1222      * @return void
1223      */
1224     public function delete($areaid = null) {
1225         if ($areaid) {
1226             $this->get_search_client()->deleteByQuery('areaid:' . $areaid);
1227         } else {
1228             $this->get_search_client()->deleteByQuery('*:*');
1229         }
1230         $this->commit();
1231     }
1233     /**
1234      * Pings the Solr server using search_solr config
1235      *
1236      * @return true|string Returns true if all good or an error string.
1237      */
1238     public function is_server_ready() {
1240         $configured = $this->is_server_configured();
1241         if ($configured !== true) {
1242             return $configured;
1243         }
1245         // As part of the above we have already checked that we can contact the server. For pages
1246         // where performance is important, we skip doing a full schema check as well.
1247         if ($this->should_skip_schema_check()) {
1248             return true;
1249         }
1251         // Update schema if required/possible.
1252         $schemalatest = $this->check_latest_schema();
1253         if ($schemalatest !== true) {
1254             return $schemalatest;
1255         }
1257         // Check that the schema is already set up.
1258         try {
1259             $schema = new \search_solr\schema();
1260             $schema->validate_setup();
1261         } catch (\moodle_exception $e) {
1262             return $e->getMessage();
1263         }
1265         return true;
1266     }
1268     /**
1269      * Is the solr server properly configured?.
1270      *
1271      * @return true|string Returns true if all good or an error string.
1272      */
1273     public function is_server_configured() {
1275         if (empty($this->config->server_hostname) || empty($this->config->indexname)) {
1276             return 'No solr configuration found';
1277         }
1279         if (!$client = $this->get_search_client(false)) {
1280             return get_string('engineserverstatus', 'search');
1281         }
1283         try {
1284             if ($this->get_solr_major_version() < 4) {
1285                 // Minimum solr 4.0.
1286                 return get_string('minimumsolr4', 'search_solr');
1287             }
1288         } catch (\SolrClientException $ex) {
1289             debugging('Solr client error: ' . html_to_text($ex->getMessage()), DEBUG_DEVELOPER);
1290             return get_string('engineserverstatus', 'search');
1291         } catch (\SolrServerException $ex) {
1292             debugging('Solr server error: ' . html_to_text($ex->getMessage()), DEBUG_DEVELOPER);
1293             return get_string('engineserverstatus', 'search');
1294         }
1296         return true;
1297     }
1299     /**
1300      * Returns the solr server major version.
1301      *
1302      * @return int
1303      */
1304     public function get_solr_major_version() {
1305         if ($this->solrmajorversion !== null) {
1306             return $this->solrmajorversion;
1307         }
1309         // We should really ping first the server to see if the specified indexname is valid but
1310         // we want to minimise solr server requests as they are expensive. system() emits a warning
1311         // if it can not connect to the configured index in the configured server.
1312         $systemdata = @$this->get_search_client()->system();
1313         $solrversion = $systemdata->getResponse()->offsetGet('lucene')->offsetGet('solr-spec-version');
1314         $this->solrmajorversion = intval(substr($solrversion, 0, strpos($solrversion, '.')));
1316         return $this->solrmajorversion;
1317     }
1319     /**
1320      * Checks if the PHP Solr extension is available.
1321      *
1322      * @return bool
1323      */
1324     public function is_installed() {
1325         return function_exists('solr_get_version');
1326     }
1328     /**
1329      * Returns the solr client instance.
1330      *
1331      * We don't reuse SolrClient if we are on libcurl 7.35.0, due to a bug in that version of curl.
1332      *
1333      * @throws \core_search\engine_exception
1334      * @param bool $triggerexception
1335      * @return \SolrClient
1336      */
1337     protected function get_search_client($triggerexception = true) {
1338         global $CFG;
1340         // Type comparison as it is set to false if not available.
1341         if ($this->client !== null) {
1342             return $this->client;
1343         }
1345         $options = array(
1346             'hostname' => $this->config->server_hostname,
1347             'path'     => '/solr/' . $this->config->indexname,
1348             'login'    => !empty($this->config->server_username) ? $this->config->server_username : '',
1349             'password' => !empty($this->config->server_password) ? $this->config->server_password : '',
1350             'port'     => !empty($this->config->server_port) ? $this->config->server_port : '',
1351             'secure' => !empty($this->config->secure) ? true : false,
1352             'ssl_cert' => !empty($this->config->ssl_cert) ? $this->config->ssl_cert : '',
1353             'ssl_key' => !empty($this->config->ssl_key) ? $this->config->ssl_key : '',
1354             'ssl_keypassword' => !empty($this->config->ssl_keypassword) ? $this->config->ssl_keypassword : '',
1355             'ssl_cainfo' => !empty($this->config->ssl_cainfo) ? $this->config->ssl_cainfo : '',
1356             'ssl_capath' => !empty($this->config->ssl_capath) ? $this->config->ssl_capath : '',
1357             'timeout' => !empty($this->config->server_timeout) ? $this->config->server_timeout : '30'
1358         );
1360         if ($CFG->proxyhost && !is_proxybypass('http://' . $this->config->server_hostname . '/')) {
1361             $options['proxy_host'] = $CFG->proxyhost;
1362             if (!empty($CFG->proxyport)) {
1363                 $options['proxy_port'] = $CFG->proxyport;
1364             }
1365             if (!empty($CFG->proxyuser) && !empty($CFG->proxypassword)) {
1366                 $options['proxy_login'] = $CFG->proxyuser;
1367                 $options['proxy_password'] = $CFG->proxypassword;
1368             }
1369         }
1371         if (!class_exists('\SolrClient')) {
1372             throw new \core_search\engine_exception('enginenotinstalled', 'search', '', 'solr');
1373         }
1375         $client = new \SolrClient($options);
1377         if ($client === false && $triggerexception) {
1378             throw new \core_search\engine_exception('engineserverstatus', 'search');
1379         }
1381         if ($this->cacheclient) {
1382             $this->client = $client;
1383         }
1385         return $client;
1386     }
1388     /**
1389      * Returns a curl object for conntecting to solr.
1390      *
1391      * @return \curl
1392      */
1393     public function get_curl_object() {
1394         if (!is_null($this->curl)) {
1395             return $this->curl;
1396         }
1398         // Connection to Solr is allowed to use 'localhost' and other potentially blocked hosts/ports.
1399         $this->curl = new \curl(['ignoresecurity' => true]);
1401         $options = array();
1402         // Build the SSL options. Based on pecl-solr and general testing.
1403         if (!empty($this->config->secure)) {
1404             if (!empty($this->config->ssl_cert)) {
1405                 $options['CURLOPT_SSLCERT'] = $this->config->ssl_cert;
1406                 $options['CURLOPT_SSLCERTTYPE'] = 'PEM';
1407             }
1409             if (!empty($this->config->ssl_key)) {
1410                 $options['CURLOPT_SSLKEY'] = $this->config->ssl_key;
1411                 $options['CURLOPT_SSLKEYTYPE'] = 'PEM';
1412             }
1414             if (!empty($this->config->ssl_keypassword)) {
1415                 $options['CURLOPT_KEYPASSWD'] = $this->config->ssl_keypassword;
1416             }
1418             if (!empty($this->config->ssl_cainfo)) {
1419                 $options['CURLOPT_CAINFO'] = $this->config->ssl_cainfo;
1420             }
1422             if (!empty($this->config->ssl_capath)) {
1423                 $options['CURLOPT_CAPATH'] = $this->config->ssl_capath;
1424             }
1425         }
1427         // Set timeout as for Solr client.
1428         $options['CURLOPT_TIMEOUT'] = !empty($this->config->server_timeout) ? $this->config->server_timeout : '30';
1430         $this->curl->setopt($options);
1432         if (!empty($this->config->server_username) && !empty($this->config->server_password)) {
1433             $authorization = $this->config->server_username . ':' . $this->config->server_password;
1434             $this->curl->setHeader('Authorization: Basic ' . base64_encode($authorization));
1435         }
1437         return $this->curl;
1438     }
1440     /**
1441      * Return a Moodle url object for the server connection.
1442      *
1443      * @param string $path The solr path to append.
1444      * @return \moodle_url
1445      */
1446     public function get_connection_url($path) {
1447         // Must use the proper protocol, or SSL will fail.
1448         $protocol = !empty($this->config->secure) ? 'https' : 'http';
1449         $url = $protocol . '://' . rtrim($this->config->server_hostname, '/');
1450         if (!empty($this->config->server_port)) {
1451             $url .= ':' . $this->config->server_port;
1452         }
1453         $url .= '/solr/' . $this->config->indexname . '/' . ltrim($path, '/');
1455         return new \moodle_url($url);
1456     }
1458     /**
1459      * Solr includes group support in the execute_query function.
1460      *
1461      * @return bool True
1462      */
1463     public function supports_group_filtering() {
1464         return true;
1465     }
1467     protected function update_schema($oldversion, $newversion) {
1468         // Construct schema.
1469         $schema = new schema();
1470         $cansetup = $schema->can_setup_server();
1471         if ($cansetup !== true) {
1472             return $cansetup;
1473         }
1475         switch ($newversion) {
1476             // This version just requires a setup call to add new fields.
1477             case 2017091700:
1478                 $setup = true;
1479                 break;
1481             // If we don't know about the schema version we might not have implemented the
1482             // change correctly, so return.
1483             default:
1484                 return get_string('schemaversionunknown', 'search');
1485         }
1487         if ($setup) {
1488             $schema->setup();
1489         }
1491         return true;
1492     }
1494     /**
1495      * Solr supports sort by location within course contexts or below.
1496      *
1497      * @param \context $context Context that the user requested search from
1498      * @return array Array from order name => display text
1499      */
1500     public function get_supported_orders(\context $context) {
1501         $orders = parent::get_supported_orders($context);
1503         // If not within a course, no other kind of sorting supported.
1504         $coursecontext = $context->get_course_context(false);
1505         if ($coursecontext) {
1506             // Within a course or activity/block, support sort by location.
1507             $orders['location'] = get_string('order_location', 'search',
1508                     $context->get_context_name());
1509         }
1511         return $orders;
1512     }
1514     /**
1515      * Solr supports search by user id.
1516      *
1517      * @return bool True
1518      */
1519     public function supports_users() {
1520         return true;
1521     }
1523     /**
1524      * Solr supports adding documents in a batch.
1525      *
1526      * @return bool True
1527      */
1528     public function supports_add_document_batch(): bool {
1529         return true;
1530     }
1532     /**
1533      * Solr supports deleting the index for a context.
1534      *
1535      * @param int $oldcontextid Context that has been deleted
1536      * @return bool True to indicate that any data was actually deleted
1537      * @throws \core_search\engine_exception
1538      */
1539     public function delete_index_for_context(int $oldcontextid) {
1540         $client = $this->get_search_client();
1541         try {
1542             $client->deleteByQuery('contextid:' . $oldcontextid);
1543             $client->commit(true);
1544             return true;
1545         } catch (\Exception $e) {
1546             throw new \core_search\engine_exception('error_solr', 'search_solr', '', $e->getMessage());
1547         }
1548     }
1550     /**
1551      * Solr supports deleting the index for a course.
1552      *
1553      * @param int $oldcourseid
1554      * @return bool True to indicate that any data was actually deleted
1555      * @throws \core_search\engine_exception
1556      */
1557     public function delete_index_for_course(int $oldcourseid) {
1558         $client = $this->get_search_client();
1559         try {
1560             $client->deleteByQuery('courseid:' . $oldcourseid);
1561             $client->commit(true);
1562             return true;
1563         } catch (\Exception $e) {
1564             throw new \core_search\engine_exception('error_solr', 'search_solr', '', $e->getMessage());
1565         }
1566     }