includes/specials/SpecialSearch.php

   1 <?php
   2 /**
   3  * Implements Special:Search
   4  *
   5  * Copyright © 2004 Brion Vibber <brion@pobox.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @ingroup SpecialPage
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27 use MediaWiki\Widget\Search\BasicSearchResultSetWidget;
  28 use MediaWiki\Widget\Search\FullSearchResultWidget;
  29 use MediaWiki\Widget\Search\InterwikiSearchResultWidget;
  30 use MediaWiki\Widget\Search\InterwikiSearchResultSetWidget;
  31 use MediaWiki\Widget\Search\SimpleSearchResultWidget;
  32 use MediaWiki\Widget\Search\SimpleSearchResultSetWidget;
  33
  34 /**
  35  * implements Special:Search - Run text & title search and display the output
  36  * @ingroup SpecialPage
  37  */
  38 class SpecialSearch extends SpecialPage {
  39         /**
  40          * Current search profile. Search profile is just a name that identifies
  41          * the active search tab on the search page (content, discussions...)
  42          * For users tt replaces the set of enabled namespaces from the query
  43          * string when applicable. Extensions can add new profiles with hooks
  44          * with custom search options just for that profile.
  45          * @var null|string
  46          */
  47         protected $profile;
  48
  49         /** @var SearchEngine Search engine */
  50         protected $searchEngine;
  51
  52         /** @var string Search engine type, if not default */
  53         protected $searchEngineType;
  54
  55         /** @var array For links */
  56         protected $extraParams = [];
  57
  58         /**
  59          * @var string The prefix url parameter. Set on the searcher and the
  60          * is expected to treat it as prefix filter on titles.
  61          */
  62         protected $mPrefix;
  63
  64         /**
  65          * @var int
  66          */
  67         protected $limit, $offset;
  68
  69         /**
  70          * @var array
  71          */
  72         protected $namespaces;
  73
  74         /**
  75          * @var string
  76          */
  77         protected $fulltext;
  78
  79         /**
  80          * @var bool
  81          */
  82         protected $runSuggestion = true;
  83
  84         /**
  85          * Search engine configurations.
  86          * @var SearchEngineConfig
  87          */
  88         protected $searchConfig;
  89
  90         const NAMESPACES_CURRENT = 'sense';
  91
  92         public function __construct() {
  93                 parent::__construct( 'Search' );
  94                 $this->searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
  95         }
  96
  97         /**
  98          * Entry point
  99          *
 100          * @param string $par
 101          */
 102         public function execute( $par ) {
 103                 $request = $this->getRequest();
 104                 $out = $this->getOutput();
 105
 106                 // Fetch the search term
 107                 $term = str_replace( "\n", " ", $request->getText( 'search' ) );
 108
 109                 // Historically search terms have been accepted not only in the search query
 110                 // parameter, but also as part of the primary url. This can have PII implications
 111                 // in releasing page view data. As such issue a 301 redirect to the correct
 112                 // URL.
 113                 if ( strlen( $par ) && !strlen( $term ) ) {
 114                         $query = $request->getValues();
 115                         unset( $query['title'] );
 116                         // Strip underscores from title parameter; most of the time we'll want
 117                         // text form here. But don't strip underscores from actual text params!
 118                         $query['search'] = str_replace( '_', ' ', $par );
 119                         $out->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
 120                         return;
 121                 }
 122
 123                 // Need to load selected namespaces before handling nsRemember
 124                 $this->load();
 125                 // TODO: This performs database actions on GET request, which is going to
 126                 // be a problem for our multi-datacenter work.
 127                 if ( !is_null( $request->getVal( 'nsRemember' ) ) ) {
 128                         $this->saveNamespaces();
 129                         // Remove the token from the URL to prevent the user from inadvertently
 130                         // exposing it (e.g. by pasting it into a public wiki page) or undoing
 131                         // later settings changes (e.g. by reloading the page).
 132                         $query = $request->getValues();
 133                         unset( $query['title'], $query['nsRemember'] );
 134                         $out->redirect( $this->getPageTitle()->getFullURL( $query ) );
 135                         return;
 136                 }
 137
 138                 $this->searchEngineType = $request->getVal( 'srbackend' );
 139                 if (
 140                         !$request->getVal( 'fulltext' ) &&
 141                         $request->getVal( 'offset' ) === null
 142                 ) {
 143                         $url = $this->goResult( $term );
 144                         if ( $url !== null ) {
 145                                 // successful 'go'
 146                                 $out->redirect( $url );
 147                                 return;
 148                         }
 149                         // No match. If it could plausibly be a title
 150                         // run the No go match hook.
 151                         $title = Title::newFromText( $term );
 152                         if ( !is_null( $title ) ) {
 153                                 Hooks::run( 'SpecialSearchNogomatch', [ &$title ] );
 154                         }
 155                 }
 156
 157                 $this->setupPage( $term );
 158
 159                 if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
 160                         $searchForwardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
 161                         if ( $searchForwardUrl ) {
 162                                 $url = str_replace( '$1', urlencode( $term ), $searchForwardUrl );
 163                                 $out->redirect( $url );
 164                         } else {
 165                                 $out->addHTML(
 166                                         "<fieldset>" .
 167                                                 "<legend>" .
 168                                                         $this->msg( 'search-external' )->escaped() .
 169                                                 "</legend>" .
 170                                                 "<p class='mw-searchdisabled'>" .
 171                                                         $this->msg( 'searchdisabled' )->escaped() .
 172                                                 "</p>" .
 173                                                 $this->msg( 'googlesearch' )->rawParams(
 174                                                         htmlspecialchars( $term ),
 175                                                         'UTF-8',
 176                                                         $this->msg( 'searchbutton' )->escaped()
 177                                                 )->text() .
 178                                         "</fieldset>"
 179                                 );
 180                         }
 181
 182                         return;
 183                 }
 184
 185                 $this->showResults( $term );
 186         }
 187
 188         /**
 189          * Set up basic search parameters from the request and user settings.
 190          *
 191          * @see tests/phpunit/includes/specials/SpecialSearchTest.php
 192          */
 193         public function load() {
 194                 $request = $this->getRequest();
 195                 list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, '' );
 196                 $this->mPrefix = $request->getVal( 'prefix', '' );
 197
 198                 $user = $this->getUser();
 199
 200                 # Extract manually requested namespaces
 201                 $nslist = $this->powerSearch( $request );
 202                 if ( !count( $nslist ) ) {
 203                         # Fallback to user preference
 204                         $nslist = $this->searchConfig->userNamespaces( $user );
 205                 }
 206
 207                 $profile = null;
 208                 if ( !count( $nslist ) ) {
 209                         $profile = 'default';
 210                 }
 211
 212                 $profile = $request->getVal( 'profile', $profile );
 213                 $profiles = $this->getSearchProfiles();
 214                 if ( $profile === null ) {
 215                         // BC with old request format
 216                         $profile = 'advanced';
 217                         foreach ( $profiles as $key => $data ) {
 218                                 if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) {
 219                                         $profile = $key;
 220                                 }
 221                         }
 222                         $this->namespaces = $nslist;
 223                 } elseif ( $profile === 'advanced' ) {
 224                         $this->namespaces = $nslist;
 225                 } else {
 226                         if ( isset( $profiles[$profile]['namespaces'] ) ) {
 227                                 $this->namespaces = $profiles[$profile]['namespaces'];
 228                         } else {
 229                                 // Unknown profile requested
 230                                 $profile = 'default';
 231                                 $this->namespaces = $profiles['default']['namespaces'];
 232                         }
 233                 }
 234
 235                 $this->fulltext = $request->getVal( 'fulltext' );
 236                 $this->runSuggestion = (bool)$request->getVal( 'runsuggestion', true );
 237                 $this->profile = $profile;
 238         }
 239
 240         /**
 241          * If an exact title match can be found, jump straight ahead to it.
 242          *
 243          * @param string $term
 244          * @return string|null The url to redirect to, or null if no redirect.
 245          */
 246         public function goResult( $term ) {
 247                 # If the string cannot be used to create a title
 248                 if ( is_null( Title::newFromText( $term ) ) ) {
 249                         return null;
 250                 }
 251                 # If there's an exact or very near match, jump right there.
 252                 $title = $this->getSearchEngine()
 253                         ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
 254                 if ( is_null( $title ) ) {
 255                         return null;
 256                 }
 257                 $url = null;
 258                 if ( !Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] ) ) {
 259                         return null;
 260                 }
 261
 262                 return $url === null ? $title->getFullUrlForRedirect() : $url;
 263         }
 264
 265         /**
 266          * @param string $term
 267          */
 268         public function showResults( $term ) {
 269                 global $wgContLang;
 270
 271                 if ( $this->searchEngineType !== null ) {
 272                         $this->setExtraParam( 'srbackend', $this->searchEngineType );
 273                 }
 274
 275                 $out = $this->getOutput();
 276                 $formWidget = new MediaWiki\Widget\Search\SearchFormWidget(
 277                         $this,
 278                         $this->searchConfig,
 279                         $this->getSearchProfiles()
 280                 );
 281                 $filePrefix = $wgContLang->getFormattedNsText( NS_FILE ) . ':';
 282                 if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
 283                         // Empty query -- straight view of search form
 284                         if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
 285                                 # Hook requested termination
 286                                 return;
 287                         }
 288                         $out->enableOOUI();
 289                         // The form also contains the 'Showing results 0 - 20 of 1234' so we can
 290                         // only do the form render here for the empty $term case. Rendering
 291                         // the form when a search is provided is repeated below.
 292                         $out->addHTML( $formWidget->render(
 293                                 $this->profile, $term, 0, 0, $this->offset, $this->isPowerSearch()
 294                         ) );
 295                         return;
 296                 }
 297
 298                 $search = $this->getSearchEngine();
 299                 $search->setFeatureData( 'rewrite', $this->runSuggestion );
 300                 $search->setLimitOffset( $this->limit, $this->offset );
 301                 $search->setNamespaces( $this->namespaces );
 302                 $search->prefix = $this->mPrefix;
 303                 $term = $search->transformSearchTerm( $term );
 304
 305                 Hooks::run( 'SpecialSearchSetupEngine', [ $this, $this->profile, $search ] );
 306                 if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
 307                         # Hook requested termination
 308                         return;
 309                 }
 310
 311                 $title = Title::newFromText( $term );
 312                 $showSuggestion = $title === null || !$title->isKnown();
 313                 $search->setShowSuggestion( $showSuggestion );
 314
 315                 // fetch search results
 316                 $rewritten = $search->replacePrefixes( $term );
 317
 318                 $titleMatches = $search->searchTitle( $rewritten );
 319                 $textMatches = $search->searchText( $rewritten );
 320
 321                 $textStatus = null;
 322                 if ( $textMatches instanceof Status ) {
 323                         $textStatus = $textMatches;
 324                         $textMatches = $textStatus->getValue();
 325                 }
 326
 327                 // Get number of results
 328                 $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
 329                 if ( $titleMatches ) {
 330                         $titleMatchesNum = $titleMatches->numRows();
 331                         $numTitleMatches = $titleMatches->getTotalHits();
 332                 }
 333                 if ( $textMatches ) {
 334                         $textMatchesNum = $textMatches->numRows();
 335                         $numTextMatches = $textMatches->getTotalHits();
 336                         if ( $textMatchesNum > 0 ) {
 337                                 $search->augmentSearchResults( $textMatches );
 338                         }
 339                 }
 340                 $num = $titleMatchesNum + $textMatchesNum;
 341                 $totalRes = $numTitleMatches + $numTextMatches;
 342
 343                 // start rendering the page
 344                 $out->enableOOUI();
 345                 $out->addHTML( $formWidget->render(
 346                         $this->profile, $term, $num, $totalRes, $this->offset, $this->isPowerSearch()
 347                 ) );
 348
 349                 // did you mean... suggestions
 350                 if ( $textMatches ) {
 351                         $dymWidget = new MediaWiki\Widget\Search\DidYouMeanWidget( $this );
 352                         $out->addHTML( $dymWidget->render( $term, $textMatches ) );
 353                 }
 354
 355                 $hasErrors = $textStatus && $textStatus->getErrors();
 356                 $hasOtherResults = $textMatches &&
 357                         $textMatches->hasInterwikiResults( SearchResultSet::INLINE_RESULTS );
 358
 359                 if ( $textMatches && $textMatches->hasInterwikiResults( SearchResultSet::SECONDARY_RESULTS ) ) {
 360                         $out->addHTML( '<div class="searchresults mw-searchresults-has-iw">' );
 361                 } else {
 362                         $out->addHTML( '<div class="searchresults">' );
 363                 }
 364
 365                 if ( $hasErrors ) {
 366                         list( $error, $warning ) = $textStatus->splitByErrorType();
 367                         if ( $error->getErrors() ) {
 368                                 $out->addHTML( Html::rawElement(
 369                                         'div',
 370                                         [ 'class' => 'errorbox' ],
 371                                         $error->getHTML( 'search-error' )
 372                                 ) );
 373                         }
 374                         if ( $warning->getErrors() ) {
 375                                 $out->addHTML( Html::rawElement(
 376                                         'div',
 377                                         [ 'class' => 'warningbox' ],
 378                                         $warning->getHTML( 'search-warning' )
 379                                 ) );
 380                         }
 381                 }
 382
 383                 // Show the create link ahead
 384                 $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
 385
 386                 Hooks::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
 387
 388                 // If we have no results and have not already displayed an error message
 389                 if ( $num === 0 && !$hasErrors ) {
 390                         $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
 391                                 $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
 392                                 wfEscapeWikiText( $term )
 393                         ] );
 394                 }
 395
 396                 // Although $num might be 0 there can still be secondary or inline
 397                 // results to display.
 398                 $linkRenderer = $this->getLinkRenderer();
 399                 $mainResultWidget = new FullSearchResultWidget( $this, $linkRenderer );
 400
 401                 if ( $search->getFeatureData( 'enable-new-crossproject-page' ) ) {
 402
 403                         $sidebarResultWidget = new InterwikiSearchResultWidget( $this, $linkRenderer );
 404                         $sidebarResultsWidget = new InterwikiSearchResultSetWidget(
 405                                 $this,
 406                                 $sidebarResultWidget,
 407                                 $linkRenderer,
 408                                 MediaWikiServices::getInstance()->getInterwikiLookup(),
 409                                 $search->getFeatureData( 'show-multimedia-search-results' )
 410                         );
 411                 } else {
 412                         $sidebarResultWidget = new SimpleSearchResultWidget( $this, $linkRenderer );
 413                         $sidebarResultsWidget = new SimpleSearchResultSetWidget(
 414                                 $this,
 415                                 $sidebarResultWidget,
 416                                 $linkRenderer,
 417                                 MediaWikiServices::getInstance()->getInterwikiLookup()
 418                         );
 419                 }
 420
 421                 $widget = new BasicSearchResultSetWidget( $this, $mainResultWidget, $sidebarResultsWidget );
 422
 423                 $out->addHTML( $widget->render(
 424                         $term, $this->offset, $titleMatches, $textMatches
 425                 ) );
 426
 427                 if ( $titleMatches ) {
 428                         $titleMatches->free();
 429                 }
 430
 431                 if ( $textMatches ) {
 432                         $textMatches->free();
 433                 }
 434
 435                 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
 436
 437                 // prev/next links
 438                 if ( $totalRes > $this->limit || $this->offset ) {
 439                         $prevnext = $this->getLanguage()->viewPrevNext(
 440                                 $this->getPageTitle(),
 441                                 $this->offset,
 442                                 $this->limit,
 443                                 $this->powerSearchOptions() + [ 'search' => $term ],
 444                                 $this->limit + $this->offset >= $totalRes
 445                         );
 446                         $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
 447                 }
 448
 449                 // Close <div class='searchresults'>
 450                 $out->addHTML( "</div>" );
 451
 452                 Hooks::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
 453         }
 454
 455         /**
 456          * @param Title $title
 457          * @param int $num The number of search results found
 458          * @param null|SearchResultSet $titleMatches Results from title search
 459          * @param null|SearchResultSet $textMatches Results from text search
 460          */
 461         protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
 462                 // show direct page/create link if applicable
 463
 464                 // Check DBkey !== '' in case of fragment link only.
 465                 if ( is_null( $title ) || $title->getDBkey() === ''
 466                         || ( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
 467                         || ( $textMatches !== null && $textMatches->searchContainedSyntax() )
 468                 ) {
 469                         // invalid title
 470                         // preserve the paragraph for margins etc...
 471                         $this->getOutput()->addHTML( '<p></p>' );
 472
 473                         return;
 474                 }
 475
 476                 $messageName = 'searchmenu-new-nocreate';
 477                 $linkClass = 'mw-search-createlink';
 478
 479                 if ( !$title->isExternal() ) {
 480                         if ( $title->isKnown() ) {
 481                                 $messageName = 'searchmenu-exists';
 482                                 $linkClass = 'mw-search-exists';
 483                         } elseif ( ContentHandler::getForTitle( $title )->supportsDirectEditing()
 484                                 && $title->quickUserCan( 'create', $this->getUser() )
 485                         ) {
 486                                 $messageName = 'searchmenu-new';
 487                         }
 488                 }
 489
 490                 $params = [
 491                         $messageName,
 492                         wfEscapeWikiText( $title->getPrefixedText() ),
 493                         Message::numParam( $num )
 494                 ];
 495                 Hooks::run( 'SpecialSearchCreateLink', [ $title, &$params ] );
 496
 497                 // Extensions using the hook might still return an empty $messageName
 498                 if ( $messageName ) {
 499                         $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
 500                 } else {
 501                         // preserve the paragraph for margins etc...
 502                         $this->getOutput()->addHTML( '<p></p>' );
 503                 }
 504         }
 505
 506         /**
 507          * Sets up everything for the HTML output page including styles, javascript,
 508          * page title, etc.
 509          *
 510          * @param string $term
 511          */
 512         protected function setupPage( $term ) {
 513                 $out = $this->getOutput();
 514
 515                 $this->setHeaders();
 516                 $this->outputHeader();
 517                 // TODO: Is this true? The namespace remember uses a user token
 518                 // on save.
 519                 $out->allowClickjacking();
 520                 $this->addHelpLink( 'Help:Searching' );
 521
 522                 if ( strval( $term ) !== '' ) {
 523                         $out->setPageTitle( $this->msg( 'searchresults' ) );
 524                         $out->setHTMLTitle( $this->msg( 'pagetitle' )
 525                                 ->rawParams( $this->msg( 'searchresults-title' )->rawParams( $term )->text() )
 526                                 ->inContentLanguage()->text()
 527                         );
 528                 }
 529
 530                 $out->addJsConfigVars( [ 'searchTerm' => $term ] );
 531                 $out->addModules( 'mediawiki.special.search' );
 532                 $out->addModuleStyles( [
 533                         'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
 534                         'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
 535                 ] );
 536         }
 537
 538         /**
 539          * Return true if current search is a power (advanced) search
 540          *
 541          * @return bool
 542          */
 543         protected function isPowerSearch() {
 544                 return $this->profile === 'advanced';
 545         }
 546
 547         /**
 548          * Extract "power search" namespace settings from the request object,
 549          * returning a list of index numbers to search.
 550          *
 551          * @param WebRequest $request
 552          * @return array
 553          */
 554         protected function powerSearch( &$request ) {
 555                 $arr = [];
 556                 foreach ( $this->searchConfig->searchableNamespaces() as $ns => $name ) {
 557                         if ( $request->getCheck( 'ns' . $ns ) ) {
 558                                 $arr[] = $ns;
 559                         }
 560                 }
 561
 562                 return $arr;
 563         }
 564
 565         /**
 566          * Reconstruct the 'power search' options for links
 567          * TODO: Instead of exposing this publicly, could we instead expose
 568          *  a function for creating search links?
 569          *
 570          * @return array
 571          */
 572         public function powerSearchOptions() {
 573                 $opt = [];
 574                 if ( $this->isPowerSearch() ) {
 575                         foreach ( $this->namespaces as $n ) {
 576                                 $opt['ns' . $n] = 1;
 577                         }
 578                 } else {
 579                         $opt['profile'] = $this->profile;
 580                 }
 581
 582                 return $opt + $this->extraParams;
 583         }
 584
 585         /**
 586          * Save namespace preferences when we're supposed to
 587          *
 588          * @return bool Whether we wrote something
 589          */
 590         protected function saveNamespaces() {
 591                 $user = $this->getUser();
 592                 $request = $this->getRequest();
 593
 594                 if ( $user->isLoggedIn() &&
 595                         $user->matchEditToken(
 596                                 $request->getVal( 'nsRemember' ),
 597                                 'searchnamespace',
 598                                 $request
 599                         ) && !wfReadOnly()
 600                 ) {
 601                         // Reset namespace preferences: namespaces are not searched
 602                         // when they're not mentioned in the URL parameters.
 603                         foreach ( MWNamespace::getValidNamespaces() as $n ) {
 604                                 $user->setOption( 'searchNs' . $n, false );
 605                         }
 606                         // The request parameters include all the namespaces to be searched.
 607                         // Even if they're the same as an existing profile, they're not eaten.
 608                         foreach ( $this->namespaces as $n ) {
 609                                 $user->setOption( 'searchNs' . $n, true );
 610                         }
 611
 612                         DeferredUpdates::addCallableUpdate( function () use ( $user ) {
 613                                 $user->saveSettings();
 614                         } );
 615
 616                         return true;
 617                 }
 618
 619                 return false;
 620         }
 621
 622         /**
 623          * @return array
 624          */
 625         protected function getSearchProfiles() {
 626                 // Builds list of Search Types (profiles)
 627                 $nsAllSet = array_keys( $this->searchConfig->searchableNamespaces() );
 628                 $defaultNs = $this->searchConfig->defaultNamespaces();
 629                 $profiles = [
 630                         'default' => [
 631                                 'message' => 'searchprofile-articles',
 632                                 'tooltip' => 'searchprofile-articles-tooltip',
 633                                 'namespaces' => $defaultNs,
 634                                 'namespace-messages' => $this->searchConfig->namespacesAsText(
 635                                         $defaultNs
 636                                 ),
 637                         ],
 638                         'images' => [
 639                                 'message' => 'searchprofile-images',
 640                                 'tooltip' => 'searchprofile-images-tooltip',
 641                                 'namespaces' => [ NS_FILE ],
 642                         ],
 643                         'all' => [
 644                                 'message' => 'searchprofile-everything',
 645                                 'tooltip' => 'searchprofile-everything-tooltip',
 646                                 'namespaces' => $nsAllSet,
 647                         ],
 648                         'advanced' => [
 649                                 'message' => 'searchprofile-advanced',
 650                                 'tooltip' => 'searchprofile-advanced-tooltip',
 651                                 'namespaces' => self::NAMESPACES_CURRENT,
 652                         ]
 653                 ];
 654
 655                 Hooks::run( 'SpecialSearchProfiles', [ &$profiles ] );
 656
 657                 foreach ( $profiles as &$data ) {
 658                         if ( !is_array( $data['namespaces'] ) ) {
 659                                 continue;
 660                         }
 661                         sort( $data['namespaces'] );
 662                 }
 663
 664                 return $profiles;
 665         }
 666
 667         /**
 668          * @since 1.18
 669          *
 670          * @return SearchEngine
 671          */
 672         public function getSearchEngine() {
 673                 if ( $this->searchEngine === null ) {
 674                         $this->searchEngine = $this->searchEngineType ?
 675                                 MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $this->searchEngineType ) :
 676                                 MediaWikiServices::getInstance()->newSearchEngine();
 677                 }
 678
 679                 return $this->searchEngine;
 680         }
 681
 682         /**
 683          * Current search profile.
 684          * @return null|string
 685          */
 686         function getProfile() {
 687                 return $this->profile;
 688         }
 689
 690         /**
 691          * Current namespaces.
 692          * @return array
 693          */
 694         function getNamespaces() {
 695                 return $this->namespaces;
 696         }
 697
 698         /**
 699          * Users of hook SpecialSearchSetupEngine can use this to
 700          * add more params to links to not lose selection when
 701          * user navigates search results.
 702          * @since 1.18
 703          *
 704          * @param string $key
 705          * @param mixed $value
 706          */
 707         public function setExtraParam( $key, $value ) {
 708                 $this->extraParams[$key] = $value;
 709         }
 710
 711         protected function getGroupName() {
 712                 return 'pages';
 713         }
 714 }