includes/search/SearchEngine.php

   1 <?php
   2 /**
   3  * Basic search engine
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Search
  22  */
  23
  24 /**
  25  * @defgroup Search Search
  26  */
  27
  28 use MediaWiki\MediaWikiServices;
  29
  30 /**
  31  * Contain a class for special pages
  32  * @ingroup Search
  33  */
  34 abstract class SearchEngine {
  35         const DEFAULT_SORT = 'relevance';
  36
  37         /** @var string */
  38         public $prefix = '';
  39
  40         /** @var int[]|null */
  41         public $namespaces = [ NS_MAIN ];
  42
  43         /** @var int */
  44         protected $limit = 10;
  45
  46         /** @var int */
  47         protected $offset = 0;
  48
  49         /**
  50          * @var string[]
  51          * @deprecated since 1.34
  52          */
  53         protected $searchTerms = [];
  54
  55         /** @var bool */
  56         protected $showSuggestion = true;
  57         private $sort = self::DEFAULT_SORT;
  58
  59         /** @var array Feature values */
  60         protected $features = [];
  61
  62         /** Profile type for completionSearch */
  63         const COMPLETION_PROFILE_TYPE = 'completionSearchProfile';
  64
  65         /** Profile type for query independent ranking features */
  66         const FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile';
  67
  68         /** Integer flag for legalSearchChars: includes all chars allowed in a search query */
  69         const CHARS_ALL = 1;
  70
  71         /** Integer flag for legalSearchChars: includes all chars allowed in a search term */
  72         const CHARS_NO_SYNTAX = 2;
  73
  74         /**
  75          * Perform a full text search query and return a result set.
  76          * If full text searches are not supported or disabled, return null.
  77          *
  78          * As of 1.32 overriding this function is deprecated. It will
  79          * be converted to final in 1.34. Override self::doSearchText().
  80          *
  81          * @param string $term Raw search term
  82          * @return ISearchResultSet|Status|null
  83          */
  84         public function searchText( $term ) {
  85                 return $this->maybePaginate( function () use ( $term ) {
  86                         return $this->doSearchText( $term );
  87                 } );
  88         }
  89
  90         /**
  91          * Perform a full text search query and return a result set.
  92          *
  93          * @param string $term Raw search term
  94          * @return ISearchResultSet|Status|null
  95          * @since 1.32
  96          */
  97         protected function doSearchText( $term ) {
  98                 return null;
  99         }
 100
 101         /**
 102          * Perform a title search in the article archive.
 103          * NOTE: these results still should be filtered by
 104          * matching against PageArchive, permissions checks etc
 105          * The results returned by this methods are only sugegstions and
 106          * may not end up being shown to the user.
 107          *
 108          * As of 1.32 overriding this function is deprecated. It will
 109          * be converted to final in 1.34. Override self::doSearchArchiveTitle().
 110          *
 111          * @param string $term Raw search term
 112          * @return Status
 113          * @since 1.29
 114          */
 115         public function searchArchiveTitle( $term ) {
 116                 return $this->doSearchArchiveTitle( $term );
 117         }
 118
 119         /**
 120          * Perform a title search in the article archive.
 121          *
 122          * @param string $term Raw search term
 123          * @return Status
 124          * @since 1.32
 125          */
 126         protected function doSearchArchiveTitle( $term ) {
 127                 return Status::newGood( [] );
 128         }
 129
 130         /**
 131          * Perform a title-only search query and return a result set.
 132          * If title searches are not supported or disabled, return null.
 133          * STUB
 134          *
 135          * As of 1.32 overriding this function is deprecated. It will
 136          * be converted to final in 1.34. Override self::doSearchTitle().
 137          *
 138          * @param string $term Raw search term
 139          * @return ISearchResultSet|null
 140          */
 141         public function searchTitle( $term ) {
 142                 return $this->maybePaginate( function () use ( $term ) {
 143                         return $this->doSearchTitle( $term );
 144                 } );
 145         }
 146
 147         /**
 148          * Perform a title-only search query and return a result set.
 149          *
 150          * @param string $term Raw search term
 151          * @return ISearchResultSet|null
 152          * @since 1.32
 153          */
 154         protected function doSearchTitle( $term ) {
 155                 return null;
 156         }
 157
 158         /**
 159          * Performs an overfetch and shrink operation to determine if
 160          * the next page is available for search engines that do not
 161          * explicitly implement their own pagination.
 162          *
 163          * @param Closure $fn Takes no arguments
 164          * @return ISearchResultSet|Status<ISearchResultSet>|null Result of calling $fn
 165          */
 166         private function maybePaginate( Closure $fn ) {
 167                 if ( $this instanceof PaginatingSearchEngine ) {
 168                         return $fn();
 169                 }
 170                 $this->limit++;
 171                 try {
 172                         $resultSetOrStatus = $fn();
 173                 } finally {
 174                         $this->limit--;
 175                 }
 176
 177                 $resultSet = null;
 178                 if ( $resultSetOrStatus instanceof ISearchResultSet ) {
 179                         $resultSet = $resultSetOrStatus;
 180                 } elseif ( $resultSetOrStatus instanceof Status &&
 181                         $resultSetOrStatus->getValue() instanceof ISearchResultSet
 182                 ) {
 183                         $resultSet = $resultSetOrStatus->getValue();
 184                 }
 185                 if ( $resultSet ) {
 186                         $resultSet->shrink( $this->limit );
 187                 }
 188
 189                 return $resultSetOrStatus;
 190         }
 191
 192         /**
 193          * @since 1.18
 194          * @param string $feature
 195          * @return bool
 196          */
 197         public function supports( $feature ) {
 198                 switch ( $feature ) {
 199                         case 'search-update':
 200                                 return true;
 201                         case 'title-suffix-filter':
 202                         default:
 203                                 return false;
 204                 }
 205         }
 206
 207         /**
 208          * Way to pass custom data for engines
 209          * @since 1.18
 210          * @param string $feature
 211          * @param mixed $data
 212          */
 213         public function setFeatureData( $feature, $data ) {
 214                 $this->features[$feature] = $data;
 215         }
 216
 217         /**
 218          * Way to retrieve custom data set by setFeatureData
 219          * or by the engine itself.
 220          * @since 1.29
 221          * @param string $feature feature name
 222          * @return mixed the feature value or null if unset
 223          */
 224         public function getFeatureData( $feature ) {
 225                 return $this->features[$feature] ?? null;
 226         }
 227
 228         /**
 229          * When overridden in derived class, performs database-specific conversions
 230          * on text to be used for searching or updating search index.
 231          * Default implementation does nothing (simply returns $string).
 232          *
 233          * @param string $string String to process
 234          * @return string
 235          */
 236         public function normalizeText( $string ) {
 237                 // Some languages such as Chinese require word segmentation
 238                 return MediaWikiServices::getInstance()->getContentLanguage()->segmentByWord( $string );
 239         }
 240
 241         /**
 242          * Get service class to finding near matches.
 243          * @param Config $config Configuration to use for the matcher.
 244          * @return SearchNearMatcher
 245          */
 246         public function getNearMatcher( Config $config ) {
 247                 return new SearchNearMatcher( $config,
 248                         MediaWikiServices::getInstance()->getContentLanguage() );
 249         }
 250
 251         /**
 252          * Get near matcher for default SearchEngine.
 253          * @return SearchNearMatcher
 254          */
 255         protected static function defaultNearMatcher() {
 256                 $services = MediaWikiServices::getInstance();
 257                 $config = $services->getMainConfig();
 258                 return $services->newSearchEngine()->getNearMatcher( $config );
 259         }
 260
 261         /**
 262          * Get chars legal for search
 263          * @param int $type type of search chars (see self::CHARS_ALL
 264          * and self::CHARS_NO_SYNTAX). Defaults to CHARS_ALL
 265          * @return string
 266          */
 267         public function legalSearchChars( $type = self::CHARS_ALL ) {
 268                 return "A-Za-z_'.0-9\\x80-\\xFF\\-";
 269         }
 270
 271         /**
 272          * Set the maximum number of results to return
 273          * and how many to skip before returning the first.
 274          *
 275          * @param int $limit
 276          * @param int $offset
 277          */
 278         function setLimitOffset( $limit, $offset = 0 ) {
 279                 $this->limit = intval( $limit );
 280                 $this->offset = intval( $offset );
 281         }
 282
 283         /**
 284          * Set which namespaces the search should include.
 285          * Give an array of namespace index numbers.
 286          *
 287          * @param int[]|null $namespaces
 288          */
 289         function setNamespaces( $namespaces ) {
 290                 if ( $namespaces ) {
 291                         // Filter namespaces to only keep valid ones
 292                         $validNs = MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
 293                         $namespaces = array_filter( $namespaces, function ( $ns ) use( $validNs ) {
 294                                 return $ns < 0 || isset( $validNs[$ns] );
 295                         } );
 296                 } else {
 297                         $namespaces = [];
 298                 }
 299                 $this->namespaces = $namespaces;
 300         }
 301
 302         /**
 303          * Set whether the searcher should try to build a suggestion.  Note: some searchers
 304          * don't support building a suggestion in the first place and others don't respect
 305          * this flag.
 306          *
 307          * @param bool $showSuggestion Should the searcher try to build suggestions
 308          */
 309         function setShowSuggestion( $showSuggestion ) {
 310                 $this->showSuggestion = $showSuggestion;
 311         }
 312
 313         /**
 314          * Get the valid sort directions.  All search engines support 'relevance' but others
 315          * might support more. The default in all implementations must be 'relevance.'
 316          *
 317          * @since 1.25
 318          * @return string[] the valid sort directions for setSort
 319          */
 320         public function getValidSorts() {
 321                 return [ self::DEFAULT_SORT ];
 322         }
 323
 324         /**
 325          * Set the sort direction of the search results. Must be one returned by
 326          * SearchEngine::getValidSorts()
 327          *
 328          * @since 1.25
 329          * @throws InvalidArgumentException
 330          * @param string $sort sort direction for query result
 331          */
 332         public function setSort( $sort ) {
 333                 if ( !in_array( $sort, $this->getValidSorts() ) ) {
 334                         throw new InvalidArgumentException( "Invalid sort: $sort. " .
 335                                 "Must be one of: " . implode( ', ', $this->getValidSorts() ) );
 336                 }
 337                 $this->sort = $sort;
 338         }
 339
 340         /**
 341          * Get the sort direction of the search results
 342          *
 343          * @since 1.25
 344          * @return string
 345          */
 346         public function getSort() {
 347                 return $this->sort;
 348         }
 349
 350         /**
 351          * Parse some common prefixes: all (search everything)
 352          * or namespace names and set the list of namespaces
 353          * of this class accordingly.
 354          *
 355          * @deprecated since 1.32; should be handled internally by the search engine
 356          * @param string $query
 357          * @return string
 358          */
 359         function replacePrefixes( $query ) {
 360                 return $query;
 361         }
 362
 363         /**
 364          * Parse some common prefixes: all (search everything)
 365          * or namespace names
 366          *
 367          * @param string $query
 368          * @param bool $withAllKeyword activate support of the "all:" keyword and its
 369          * translations to activate searching on all namespaces.
 370          * @param bool $withPrefixSearchExtractNamespaceHook call the PrefixSearchExtractNamespace hook
 371          *  if classic namespace identification did not match.
 372          * @return false|array false if no namespace was extracted, an array
 373          * with the parsed query at index 0 and an array of namespaces at index
 374          * 1 (or null for all namespaces).
 375          * @throws FatalError
 376          * @throws MWException
 377          */
 378         public static function parseNamespacePrefixes(
 379                 $query,
 380                 $withAllKeyword = true,
 381                 $withPrefixSearchExtractNamespaceHook = false
 382         ) {
 383                 $parsed = $query;
 384                 if ( strpos( $query, ':' ) === false ) { // nothing to do
 385                         return false;
 386                 }
 387                 $extractedNamespace = null;
 388
 389                 $allQuery = false;
 390                 if ( $withAllKeyword ) {
 391                         $allkeywords = [];
 392
 393                         $allkeywords[] = wfMessage( 'searchall' )->inContentLanguage()->text() . ":";
 394                         // force all: so that we have a common syntax for all the wikis
 395                         if ( !in_array( 'all:', $allkeywords ) ) {
 396                                 $allkeywords[] = 'all:';
 397                         }
 398
 399                         foreach ( $allkeywords as $kw ) {
 400                                 if ( strncmp( $query, $kw, strlen( $kw ) ) == 0 ) {
 401                                         $extractedNamespace = null;
 402                                         $parsed = substr( $query, strlen( $kw ) );
 403                                         $allQuery = true;
 404                                         break;
 405                                 }
 406                         }
 407                 }
 408
 409                 if ( !$allQuery && strpos( $query, ':' ) !== false ) {
 410                         $prefix = str_replace( ' ', '_', substr( $query, 0, strpos( $query, ':' ) ) );
 411                         $index = MediaWikiServices::getInstance()->getContentLanguage()->getNsIndex( $prefix );
 412                         if ( $index !== false ) {
 413                                 $extractedNamespace = [ $index ];
 414                                 $parsed = substr( $query, strlen( $prefix ) + 1 );
 415                         } elseif ( $withPrefixSearchExtractNamespaceHook ) {
 416                                 $hookNamespaces = [ NS_MAIN ];
 417                                 $hookQuery = $query;
 418                                 Hooks::run( 'PrefixSearchExtractNamespace', [ &$hookNamespaces, &$hookQuery ] );
 419                                 if ( $hookQuery !== $query ) {
 420                                         $parsed = $hookQuery;
 421                                         $extractedNamespace = $hookNamespaces;
 422                                 } else {
 423                                         return false;
 424                                 }
 425                         } else {
 426                                 return false;
 427                         }
 428                 }
 429
 430                 return [ $parsed, $extractedNamespace ];
 431         }
 432
 433         /**
 434          * Find snippet highlight settings for all users
 435          * @return array Contextlines, contextchars
 436          * @deprecated in 1.34 use the SearchHighlighter constants directly
 437          * @see SearchHighlighter::DEFAULT_CONTEXT_CHARS
 438          * @see SearchHighlighter::DEFAULT_CONTEXT_LINES
 439          */
 440         public static function userHighlightPrefs() {
 441                 $contextlines = SearchHighlighter::DEFAULT_CONTEXT_LINES;
 442                 $contextchars = SearchHighlighter::DEFAULT_CONTEXT_CHARS;
 443                 return [ $contextlines, $contextchars ];
 444         }
 445
 446         /**
 447          * Create or update the search index record for the given page.
 448          * Title and text should be pre-processed.
 449          * STUB
 450          *
 451          * @param int $id
 452          * @param string $title
 453          * @param string $text
 454          */
 455         function update( $id, $title, $text ) {
 456                 // no-op
 457         }
 458
 459         /**
 460          * Update a search index record's title only.
 461          * Title should be pre-processed.
 462          * STUB
 463          *
 464          * @param int $id
 465          * @param string $title
 466          */
 467         function updateTitle( $id, $title ) {
 468                 // no-op
 469         }
 470
 471         /**
 472          * Delete an indexed page
 473          * Title should be pre-processed.
 474          * STUB
 475          *
 476          * @param int $id Page id that was deleted
 477          * @param string $title Title of page that was deleted
 478          */
 479         function delete( $id, $title ) {
 480                 // no-op
 481         }
 482
 483         /**
 484          * Get the raw text for updating the index from a content object
 485          * Nicer search backends could possibly do something cooler than
 486          * just returning raw text
 487          *
 488          * @todo This isn't ideal, we'd really like to have content-specific handling here
 489          * @param Title $t Title we're indexing
 490          * @param Content|null $c Content of the page to index
 491          * @return string
 492          */
 493         public function getTextFromContent( Title $t, Content $c = null ) {
 494                 return $c ? $c->getTextForSearchIndex() : '';
 495         }
 496
 497         /**
 498          * If an implementation of SearchEngine handles all of its own text processing
 499          * in getTextFromContent() and doesn't require SearchUpdate::updateText()'s
 500          * rather silly handling, it should return true here instead.
 501          *
 502          * @return bool
 503          */
 504         public function textAlreadyUpdatedForIndex() {
 505                 return false;
 506         }
 507
 508         /**
 509          * Makes search simple string if it was namespaced.
 510          * Sets namespaces of the search to namespaces extracted from string.
 511          * @param string $search
 512          * @return string Simplified search string
 513          */
 514         protected function normalizeNamespaces( $search ) {
 515                 $queryAndNs = self::parseNamespacePrefixes( $search, false, true );
 516                 if ( $queryAndNs !== false ) {
 517                         $this->setNamespaces( $queryAndNs[1] );
 518                         return $queryAndNs[0];
 519                 }
 520                 return $search;
 521         }
 522
 523         /**
 524          * Perform an overfetch of completion search results. This allows
 525          * determining if another page of results is available.
 526          *
 527          * @param string $search
 528          * @return SearchSuggestionSet
 529          */
 530         protected function completionSearchBackendOverfetch( $search ) {
 531                 $this->limit++;
 532                 try {
 533                         return $this->completionSearchBackend( $search );
 534                 } finally {
 535                         $this->limit--;
 536                 }
 537         }
 538
 539         /**
 540          * Perform a completion search.
 541          * Does not resolve namespaces and does not check variants.
 542          * Search engine implementations may want to override this function.
 543          * @param string $search
 544          * @return SearchSuggestionSet
 545          */
 546         protected function completionSearchBackend( $search ) {
 547                 $results = [];
 548
 549                 $search = trim( $search );
 550
 551                 if ( !in_array( NS_SPECIAL, $this->namespaces ) && // We do not run hook on Special: search
 552                          !Hooks::run( 'PrefixSearchBackend',
 553                                 [ $this->namespaces, $search, $this->limit, &$results, $this->offset ]
 554                 ) ) {
 555                         // False means hook worked.
 556                         // FIXME: Yes, the API is weird. That's why it is going to be deprecated.
 557
 558                         return SearchSuggestionSet::fromStrings( $results );
 559                 } else {
 560                         // Hook did not do the job, use default simple search
 561                         $results = $this->simplePrefixSearch( $search );
 562                         return SearchSuggestionSet::fromTitles( $results );
 563                 }
 564         }
 565
 566         /**
 567          * Perform a completion search.
 568          * @param string $search
 569          * @return SearchSuggestionSet
 570          */
 571         public function completionSearch( $search ) {
 572                 if ( trim( $search ) === '' ) {
 573                         return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
 574                 }
 575                 $search = $this->normalizeNamespaces( $search );
 576                 $suggestions = $this->completionSearchBackendOverfetch( $search );
 577                 return $this->processCompletionResults( $search, $suggestions );
 578         }
 579
 580         /**
 581          * Perform a completion search with variants.
 582          * @param string $search
 583          * @return SearchSuggestionSet
 584          */
 585         public function completionSearchWithVariants( $search ) {
 586                 if ( trim( $search ) === '' ) {
 587                         return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
 588                 }
 589                 $search = $this->normalizeNamespaces( $search );
 590
 591                 $results = $this->completionSearchBackendOverfetch( $search );
 592                 $fallbackLimit = 1 + $this->limit - $results->getSize();
 593                 if ( $fallbackLimit > 0 ) {
 594                         $fallbackSearches = MediaWikiServices::getInstance()->getContentLanguage()->
 595                                 autoConvertToAllVariants( $search );
 596                         $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
 597
 598                         foreach ( $fallbackSearches as $fbs ) {
 599                                 $this->setLimitOffset( $fallbackLimit );
 600                                 $fallbackSearchResult = $this->completionSearch( $fbs );
 601                                 $results->appendAll( $fallbackSearchResult );
 602                                 $fallbackLimit -= $fallbackSearchResult->getSize();
 603                                 if ( $fallbackLimit <= 0 ) {
 604                                         break;
 605                                 }
 606                         }
 607                 }
 608                 return $this->processCompletionResults( $search, $results );
 609         }
 610
 611         /**
 612          * Extract titles from completion results
 613          * @param SearchSuggestionSet $completionResults
 614          * @return Title[]
 615          */
 616         public function extractTitles( SearchSuggestionSet $completionResults ) {
 617                 return $completionResults->map( function ( SearchSuggestion $sugg ) {
 618                         return $sugg->getSuggestedTitle();
 619                 } );
 620         }
 621
 622         /**
 623          * Process completion search results.
 624          * Resolves the titles and rescores.
 625          * @param string $search
 626          * @param SearchSuggestionSet $suggestions
 627          * @return SearchSuggestionSet
 628          */
 629         protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
 630                 // We over-fetched to determine pagination. Shrink back down if we have extra results
 631                 // and mark if pagination is possible
 632                 $suggestions->shrink( $this->limit );
 633
 634                 $search = trim( $search );
 635                 // preload the titles with LinkBatch
 636                 $lb = new LinkBatch( $suggestions->map( function ( SearchSuggestion $sugg ) {
 637                         return $sugg->getSuggestedTitle();
 638                 } ) );
 639                 $lb->setCaller( __METHOD__ );
 640                 $lb->execute();
 641
 642                 $diff = $suggestions->filter( function ( SearchSuggestion $sugg ) {
 643                         return $sugg->getSuggestedTitle()->isKnown();
 644                 } );
 645                 if ( $diff > 0 ) {
 646                         MediaWikiServices::getInstance()->getStatsdDataFactory()
 647                                 ->updateCount( 'search.completion.missing', $diff );
 648                 }
 649
 650                 $results = $suggestions->map( function ( SearchSuggestion $sugg ) {
 651                         return $sugg->getSuggestedTitle()->getPrefixedText();
 652                 } );
 653
 654                 if ( $this->offset === 0 ) {
 655                         // Rescore results with an exact title match
 656                         // NOTE: in some cases like cross-namespace redirects
 657                         // (frequently used as shortcuts e.g. WP:WP on huwiki) some
 658                         // backends like Cirrus will return no results. We should still
 659                         // try an exact title match to workaround this limitation
 660                         $rescorer = new SearchExactMatchRescorer();
 661                         $rescoredResults = $rescorer->rescore( $search, $this->namespaces, $results, $this->limit );
 662                 } else {
 663                         // No need to rescore if offset is not 0
 664                         // The exact match must have been returned at position 0
 665                         // if it existed.
 666                         $rescoredResults = $results;
 667                 }
 668
 669                 if ( count( $rescoredResults ) > 0 ) {
 670                         $found = array_search( $rescoredResults[0], $results );
 671                         if ( $found === false ) {
 672                                 // If the first result is not in the previous array it
 673                                 // means that we found a new exact match
 674                                 $exactMatch = SearchSuggestion::fromTitle( 0, Title::newFromText( $rescoredResults[0] ) );
 675                                 $suggestions->prepend( $exactMatch );
 676                                 $suggestions->shrink( $this->limit );
 677                         } else {
 678                                 // if the first result is not the same we need to rescore
 679                                 if ( $found > 0 ) {
 680                                         $suggestions->rescore( $found );
 681                                 }
 682                         }
 683                 }
 684
 685                 return $suggestions;
 686         }
 687
 688         /**
 689          * Simple prefix search for subpages.
 690          * @param string $search
 691          * @return Title[]
 692          */
 693         public function defaultPrefixSearch( $search ) {
 694                 if ( trim( $search ) === '' ) {
 695                         return [];
 696                 }
 697
 698                 $search = $this->normalizeNamespaces( $search );
 699                 return $this->simplePrefixSearch( $search );
 700         }
 701
 702         /**
 703          * Call out to simple search backend.
 704          * Defaults to TitlePrefixSearch.
 705          * @param string $search
 706          * @return Title[]
 707          */
 708         protected function simplePrefixSearch( $search ) {
 709                 // Use default database prefix search
 710                 $backend = new TitlePrefixSearch;
 711                 return $backend->defaultSearchBackend( $this->namespaces, $search, $this->limit, $this->offset );
 712         }
 713
 714         /**
 715          * Get a list of supported profiles.
 716          * Some search engine implementations may expose specific profiles to fine-tune
 717          * its behaviors.
 718          * The profile can be passed as a feature data with setFeatureData( $profileType, $profileName )
 719          * The array returned by this function contains the following keys:
 720          * - name: the profile name to use with setFeatureData
 721          * - desc-message: the i18n description
 722          * - default: set to true if this profile is the default
 723          *
 724          * @since 1.28
 725          * @param string $profileType the type of profiles
 726          * @param User|null $user the user requesting the list of profiles
 727          * @return array|null the list of profiles or null if none available
 728          */
 729         public function getProfiles( $profileType, User $user = null ) {
 730                 return null;
 731         }
 732
 733         /**
 734          * Create a search field definition.
 735          * Specific search engines should override this method to create search fields.
 736          * @param string $name
 737          * @param string $type One of the types in SearchIndexField::INDEX_TYPE_*
 738          * @return SearchIndexField
 739          * @since 1.28
 740          */
 741         public function makeSearchFieldMapping( $name, $type ) {
 742                 return new NullIndexField();
 743         }
 744
 745         /**
 746          * Get fields for search index
 747          * @since 1.28
 748          * @return SearchIndexField[] Index field definitions for all content handlers
 749          */
 750         public function getSearchIndexFields() {
 751                 $models = ContentHandler::getContentModels();
 752                 $fields = [];
 753                 $seenHandlers = new SplObjectStorage();
 754                 foreach ( $models as $model ) {
 755                         try {
 756                                 $handler = ContentHandler::getForModelID( $model );
 757                         }
 758                         catch ( MWUnknownContentModelException $e ) {
 759                                 // If we can find no handler, ignore it
 760                                 continue;
 761                         }
 762                         // Several models can have the same handler, so avoid processing it repeatedly
 763                         if ( $seenHandlers->contains( $handler ) ) {
 764                                 // We already did this one
 765                                 continue;
 766                         }
 767                         $seenHandlers->attach( $handler );
 768                         $handlerFields = $handler->getFieldsForSearchIndex( $this );
 769                         foreach ( $handlerFields as $fieldName => $fieldData ) {
 770                                 if ( empty( $fields[$fieldName] ) ) {
 771                                         $fields[$fieldName] = $fieldData;
 772                                 } else {
 773                                         // TODO: do we allow some clashes with the same type or reject all of them?
 774                                         $mergeDef = $fields[$fieldName]->merge( $fieldData );
 775                                         if ( !$mergeDef ) {
 776                                                 throw new InvalidArgumentException( "Duplicate field $fieldName for model $model" );
 777                                         }
 778                                         $fields[$fieldName] = $mergeDef;
 779                                 }
 780                         }
 781                 }
 782                 // Hook to allow extensions to produce search mapping fields
 783                 Hooks::run( 'SearchIndexFields', [ &$fields, $this ] );
 784                 return $fields;
 785         }
 786
 787         /**
 788          * Augment search results with extra data.
 789          *
 790          * @param ISearchResultSet $resultSet
 791          */
 792         public function augmentSearchResults( ISearchResultSet $resultSet ) {
 793                 $setAugmentors = [];
 794                 $rowAugmentors = [];
 795                 Hooks::run( "SearchResultsAugment", [ &$setAugmentors, &$rowAugmentors ] );
 796                 if ( !$setAugmentors && !$rowAugmentors ) {
 797                         // We're done here
 798                         return;
 799                 }
 800
 801                 // Convert row augmentors to set augmentor
 802                 foreach ( $rowAugmentors as $name => $row ) {
 803                         if ( isset( $setAugmentors[$name] ) ) {
 804                                 throw new InvalidArgumentException( "Both row and set augmentors are defined for $name" );
 805                         }
 806                         $setAugmentors[$name] = new PerRowAugmentor( $row );
 807                 }
 808
 809                 /**
 810                  * @var string $name
 811                  * @var ResultSetAugmentor $augmentor
 812                  */
 813                 foreach ( $setAugmentors as $name => $augmentor ) {
 814                         $data = $augmentor->augmentAll( $resultSet );
 815                         if ( $data ) {
 816                                 $resultSet->setAugmentedData( $name, $data );
 817                         }
 818                 }
 819         }
 820 }