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 string
  81          */
  82         protected $sort;
  83
  84         /**
  85          * @var bool
  86          */
  87         protected $runSuggestion = true;
  88
  89         /**
  90          * Search engine configurations.
  91          * @var SearchEngineConfig
  92          */
  93         protected $searchConfig;
  94
  95         const NAMESPACES_CURRENT = 'sense';
  96
  97         public function __construct() {
  98                 parent::__construct( 'Search' );
  99                 $this->searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
 100         }
 101
 102         /**
 103          * Entry point
 104          *
 105          * @param string|null $par
 106          */
 107         public function execute( $par ) {
 108                 $request = $this->getRequest();
 109                 $out = $this->getOutput();
 110
 111                 // Fetch the search term
 112                 $term = str_replace( "\n", " ", $request->getText( 'search' ) );
 113
 114                 // Historically search terms have been accepted not only in the search query
 115                 // parameter, but also as part of the primary url. This can have PII implications
 116                 // in releasing page view data. As such issue a 301 redirect to the correct
 117                 // URL.
 118                 if ( $par !== null && $par !== '' && $term === '' ) {
 119                         $query = $request->getValues();
 120                         unset( $query['title'] );
 121                         // Strip underscores from title parameter; most of the time we'll want
 122                         // text form here. But don't strip underscores from actual text params!
 123                         $query['search'] = str_replace( '_', ' ', $par );
 124                         $out->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
 125                         return;
 126                 }
 127
 128                 // Need to load selected namespaces before handling nsRemember
 129                 $this->load();
 130                 // TODO: This performs database actions on GET request, which is going to
 131                 // be a problem for our multi-datacenter work.
 132                 if ( $request->getCheck( 'nsRemember' ) ) {
 133                         $this->saveNamespaces();
 134                         // Remove the token from the URL to prevent the user from inadvertently
 135                         // exposing it (e.g. by pasting it into a public wiki page) or undoing
 136                         // later settings changes (e.g. by reloading the page).
 137                         $query = $request->getValues();
 138                         unset( $query['title'], $query['nsRemember'] );
 139                         $out->redirect( $this->getPageTitle()->getFullURL( $query ) );
 140                         return;
 141                 }
 142
 143                 $this->searchEngineType = $request->getVal( 'srbackend' );
 144                 if ( !$request->getVal( 'fulltext' ) && !$request->getCheck( 'offset' ) ) {
 145                         $url = $this->goResult( $term );
 146                         if ( $url !== null ) {
 147                                 // successful 'go'
 148                                 $out->redirect( $url );
 149                                 return;
 150                         }
 151                         // No match. If it could plausibly be a title
 152                         // run the No go match hook.
 153                         $title = Title::newFromText( $term );
 154                         if ( !is_null( $title ) ) {
 155                                 Hooks::run( 'SpecialSearchNogomatch', [ &$title ] );
 156                         }
 157                 }
 158
 159                 $this->setupPage( $term );
 160
 161                 if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
 162                         $searchForwardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
 163                         if ( $searchForwardUrl ) {
 164                                 $url = str_replace( '$1', urlencode( $term ), $searchForwardUrl );
 165                                 $out->redirect( $url );
 166                         } else {
 167                                 $this->showGoogleSearch( $term );
 168                         }
 169
 170                         return;
 171                 }
 172
 173                 $this->showResults( $term );
 174         }
 175
 176         /**
 177          * Output a google search form if search is disabled
 178          *
 179          * @param string $term Search term
 180          * @todo FIXME Maybe we should get rid of this raw html message at some future time
 181          * @suppress SecurityCheck-XSS
 182          */
 183         private function showGoogleSearch( $term ) {
 184                 $this->getOutput()->addHTML(
 185                         "<fieldset>" .
 186                                 "<legend>" .
 187                                         $this->msg( 'search-external' )->escaped() .
 188                                 "</legend>" .
 189                                 "<p class='mw-searchdisabled'>" .
 190                                         $this->msg( 'searchdisabled' )->escaped() .
 191                                 "</p>" .
 192                                 $this->msg( 'googlesearch' )->rawParams(
 193                                         htmlspecialchars( $term ),
 194                                         'UTF-8',
 195                                         $this->msg( 'searchbutton' )->escaped()
 196                                 )->text() .
 197                         "</fieldset>"
 198                 );
 199         }
 200
 201         /**
 202          * Set up basic search parameters from the request and user settings.
 203          *
 204          * @see tests/phpunit/includes/specials/SpecialSearchTest.php
 205          */
 206         public function load() {
 207                 $request = $this->getRequest();
 208                 list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, '' );
 209                 $this->mPrefix = $request->getVal( 'prefix', '' );
 210                 if ( $this->mPrefix !== '' ) {
 211                         $this->setExtraParam( 'prefix', $this->mPrefix );
 212                 }
 213
 214                 $this->sort = $request->getVal( 'sort', SearchEngine::DEFAULT_SORT );
 215                 if ( $this->sort !== SearchEngine::DEFAULT_SORT ) {
 216                         $this->setExtraParam( 'sort', $this->sort );
 217                 }
 218
 219                 $user = $this->getUser();
 220
 221                 # Extract manually requested namespaces
 222                 $nslist = $this->powerSearch( $request );
 223                 if ( $nslist === [] ) {
 224                         # Fallback to user preference
 225                         $nslist = $this->searchConfig->userNamespaces( $user );
 226                 }
 227
 228                 $profile = null;
 229                 if ( $nslist === [] ) {
 230                         $profile = 'default';
 231                 }
 232
 233                 $profile = $request->getVal( 'profile', $profile );
 234                 $profiles = $this->getSearchProfiles();
 235                 if ( $profile === null ) {
 236                         // BC with old request format
 237                         $profile = 'advanced';
 238                         foreach ( $profiles as $key => $data ) {
 239                                 if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) {
 240                                         $profile = $key;
 241                                 }
 242                         }
 243                         $this->namespaces = $nslist;
 244                 } elseif ( $profile === 'advanced' ) {
 245                         $this->namespaces = $nslist;
 246                 } elseif ( isset( $profiles[$profile]['namespaces'] ) ) {
 247                         $this->namespaces = $profiles[$profile]['namespaces'];
 248                 } else {
 249                         // Unknown profile requested
 250                         $profile = 'default';
 251                         $this->namespaces = $profiles['default']['namespaces'];
 252                 }
 253
 254                 $this->fulltext = $request->getVal( 'fulltext' );
 255                 $this->runSuggestion = (bool)$request->getVal( 'runsuggestion', true );
 256                 $this->profile = $profile;
 257         }
 258
 259         /**
 260          * If an exact title match can be found, jump straight ahead to it.
 261          *
 262          * @param string $term
 263          * @return string|null The url to redirect to, or null if no redirect.
 264          */
 265         public function goResult( $term ) {
 266                 # If the string cannot be used to create a title
 267                 if ( is_null( Title::newFromText( $term ) ) ) {
 268                         return null;
 269                 }
 270                 # If there's an exact or very near match, jump right there.
 271                 $title = $this->getSearchEngine()
 272                         ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
 273                 if ( is_null( $title ) ) {
 274                         return null;
 275                 }
 276                 $url = null;
 277                 if ( !Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] ) ) {
 278                         return null;
 279                 }
 280
 281                 return $url ?? $title->getFullUrlForRedirect();
 282         }
 283
 284         /**
 285          * @param string $term
 286          */
 287         public function showResults( $term ) {
 288                 if ( $this->searchEngineType !== null ) {
 289                         $this->setExtraParam( 'srbackend', $this->searchEngineType );
 290                 }
 291
 292                 $out = $this->getOutput();
 293                 $widgetOptions = $this->getConfig()->get( 'SpecialSearchFormOptions' );
 294                 $formWidget = new MediaWiki\Widget\Search\SearchFormWidget(
 295                         $this,
 296                         $this->searchConfig,
 297                         $this->getSearchProfiles()
 298                 );
 299                 $filePrefix = MediaWikiServices::getInstance()->getContentLanguage()->
 300                         getFormattedNsText( NS_FILE ) . ':';
 301                 if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
 302                         // Empty query -- straight view of search form
 303                         if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
 304                                 # Hook requested termination
 305                                 return;
 306                         }
 307                         $out->enableOOUI();
 308                         // The form also contains the 'Showing results 0 - 20 of 1234' so we can
 309                         // only do the form render here for the empty $term case. Rendering
 310                         // the form when a search is provided is repeated below.
 311                         $out->addHTML( $formWidget->render(
 312                                 $this->profile, $term, 0, 0, $this->offset, $this->isPowerSearch(), $widgetOptions
 313                         ) );
 314                         return;
 315                 }
 316
 317                 $search = $this->getSearchEngine();
 318                 $search->setFeatureData( 'rewrite', $this->runSuggestion );
 319                 $search->setLimitOffset( $this->limit, $this->offset );
 320                 $search->setNamespaces( $this->namespaces );
 321                 $search->setSort( $this->sort );
 322                 $search->prefix = $this->mPrefix;
 323
 324                 Hooks::run( 'SpecialSearchSetupEngine', [ $this, $this->profile, $search ] );
 325                 if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
 326                         # Hook requested termination
 327                         return;
 328                 }
 329
 330                 $title = Title::newFromText( $term );
 331                 $showSuggestion = $title === null || !$title->isKnown();
 332                 $search->setShowSuggestion( $showSuggestion );
 333
 334                 $rewritten = $search->replacePrefixes( $term );
 335                 if ( $rewritten !== $term ) {
 336                         wfDeprecated( 'SearchEngine::replacePrefixes() (overridden by ' .
 337                                                   get_class( $search ) . ')', '1.32' );
 338                 }
 339
 340                 // fetch search results
 341                 $titleMatches = $search->searchTitle( $rewritten );
 342                 $textMatches = $search->searchText( $rewritten );
 343
 344                 $textStatus = null;
 345                 if ( $textMatches instanceof Status ) {
 346                         $textStatus = $textMatches;
 347                         $textMatches = $textStatus->getValue();
 348                 }
 349
 350                 // Get number of results
 351                 $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
 352                 if ( $titleMatches ) {
 353                         $titleMatchesNum = $titleMatches->numRows();
 354                         $numTitleMatches = $titleMatches->getTotalHits();
 355                 }
 356                 if ( $textMatches ) {
 357                         $textMatchesNum = $textMatches->numRows();
 358                         $numTextMatches = $textMatches->getTotalHits();
 359                         if ( $textMatchesNum > 0 ) {
 360                                 $search->augmentSearchResults( $textMatches );
 361                         }
 362                 }
 363                 $num = $titleMatchesNum + $textMatchesNum;
 364                 $totalRes = $numTitleMatches + $numTextMatches;
 365
 366                 // start rendering the page
 367                 $out->enableOOUI();
 368                 $out->addHTML( $formWidget->render(
 369                         $this->profile, $term, $num, $totalRes, $this->offset, $this->isPowerSearch(), $widgetOptions
 370                 ) );
 371
 372                 // did you mean... suggestions
 373                 if ( $textMatches ) {
 374                         $dymWidget = new MediaWiki\Widget\Search\DidYouMeanWidget( $this );
 375                         $out->addHTML( $dymWidget->render( $term, $textMatches ) );
 376                 }
 377
 378                 $hasErrors = $textStatus && $textStatus->getErrors() !== [];
 379                 $hasOtherResults = $textMatches &&
 380                         $textMatches->hasInterwikiResults( SearchResultSet::INLINE_RESULTS );
 381
 382                 if ( $textMatches && $textMatches->hasInterwikiResults( SearchResultSet::SECONDARY_RESULTS ) ) {
 383                         $out->addHTML( '<div class="searchresults mw-searchresults-has-iw">' );
 384                 } else {
 385                         $out->addHTML( '<div class="searchresults">' );
 386                 }
 387
 388                 if ( $hasErrors ) {
 389                         list( $error, $warning ) = $textStatus->splitByErrorType();
 390                         if ( $error->getErrors() ) {
 391                                 $out->addHTML( Html::errorBox(
 392                                         $error->getHTML( 'search-error' )
 393                                 ) );
 394                         }
 395                         if ( $warning->getErrors() ) {
 396                                 $out->addHTML( Html::warningBox(
 397                                         $warning->getHTML( 'search-warning' )
 398                                 ) );
 399                         }
 400                 }
 401
 402                 // Show the create link ahead
 403                 $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
 404
 405                 Hooks::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
 406
 407                 // If we have no results and have not already displayed an error message
 408                 if ( $num === 0 && !$hasErrors ) {
 409                         $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
 410                                 $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
 411                                 wfEscapeWikiText( $term )
 412                         ] );
 413                 }
 414
 415                 // Although $num might be 0 there can still be secondary or inline
 416                 // results to display.
 417                 $linkRenderer = $this->getLinkRenderer();
 418                 $mainResultWidget = new FullSearchResultWidget( $this, $linkRenderer );
 419
 420                 // Default (null) on. Can be explicitly disabled.
 421                 if ( $search->getFeatureData( 'enable-new-crossproject-page' ) !== false ) {
 422                         $sidebarResultWidget = new InterwikiSearchResultWidget( $this, $linkRenderer );
 423                         $sidebarResultsWidget = new InterwikiSearchResultSetWidget(
 424                                 $this,
 425                                 $sidebarResultWidget,
 426                                 $linkRenderer,
 427                                 MediaWikiServices::getInstance()->getInterwikiLookup(),
 428                                 $search->getFeatureData( 'show-multimedia-search-results' )
 429                         );
 430                 } else {
 431                         $sidebarResultWidget = new SimpleSearchResultWidget( $this, $linkRenderer );
 432                         $sidebarResultsWidget = new SimpleSearchResultSetWidget(
 433                                 $this,
 434                                 $sidebarResultWidget,
 435                                 $linkRenderer,
 436                                 MediaWikiServices::getInstance()->getInterwikiLookup()
 437                         );
 438                 }
 439
 440                 $widget = new BasicSearchResultSetWidget( $this, $mainResultWidget, $sidebarResultsWidget );
 441
 442                 $out->addHTML( $widget->render(
 443                         $term, $this->offset, $titleMatches, $textMatches
 444                 ) );
 445
 446                 if ( $titleMatches ) {
 447                         $titleMatches->free();
 448                 }
 449
 450                 if ( $textMatches ) {
 451                         $textMatches->free();
 452                 }
 453
 454                 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
 455
 456                 // prev/next links
 457                 if ( $totalRes > $this->limit || $this->offset ) {
 458                         // Allow matches to define the correct offset, as interleaved
 459                         // AB testing may require a different next page offset.
 460                         if ( $textMatches && $textMatches->getOffset() !== null ) {
 461                                 $offset = $textMatches->getOffset();
 462                         } else {
 463                                 $offset = $this->offset;
 464                         }
 465
 466                         $prevnext = $this->buildPrevNextNavigation(
 467                                 $offset,
 468                                 $this->limit,
 469                                 $this->powerSearchOptions() + [ 'search' => $term ],
 470                                 $this->limit + $this->offset >= $totalRes
 471                         );
 472                         $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
 473                 }
 474
 475                 // Close <div class='searchresults'>
 476                 $out->addHTML( "</div>" );
 477
 478                 Hooks::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
 479         }
 480
 481         /**
 482          * @param Title $title
 483          * @param int $num The number of search results found
 484          * @param null|SearchResultSet $titleMatches Results from title search
 485          * @param null|SearchResultSet $textMatches Results from text search
 486          */
 487         protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
 488                 // show direct page/create link if applicable
 489
 490                 // Check DBkey !== '' in case of fragment link only.
 491                 if ( is_null( $title ) || $title->getDBkey() === ''
 492                         || ( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
 493                         || ( $textMatches !== null && $textMatches->searchContainedSyntax() )
 494                 ) {
 495                         // invalid title
 496                         // preserve the paragraph for margins etc...
 497                         $this->getOutput()->addHTML( '<p></p>' );
 498
 499                         return;
 500                 }
 501
 502                 $messageName = 'searchmenu-new-nocreate';
 503                 $linkClass = 'mw-search-createlink';
 504
 505                 if ( !$title->isExternal() ) {
 506                         if ( $title->isKnown() ) {
 507                                 $messageName = 'searchmenu-exists';
 508                                 $linkClass = 'mw-search-exists';
 509                         } elseif ( ContentHandler::getForTitle( $title )->supportsDirectEditing()
 510                                 && $title->quickUserCan( 'create', $this->getUser() )
 511                         ) {
 512                                 $messageName = 'searchmenu-new';
 513                         }
 514                 }
 515
 516                 $params = [
 517                         $messageName,
 518                         wfEscapeWikiText( $title->getPrefixedText() ),
 519                         Message::numParam( $num )
 520                 ];
 521                 Hooks::run( 'SpecialSearchCreateLink', [ $title, &$params ] );
 522
 523                 // Extensions using the hook might still return an empty $messageName
 524                 if ( $messageName ) {
 525                         $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
 526                 } else {
 527                         // preserve the paragraph for margins etc...
 528                         $this->getOutput()->addHTML( '<p></p>' );
 529                 }
 530         }
 531
 532         /**
 533          * Sets up everything for the HTML output page including styles, javascript,
 534          * page title, etc.
 535          *
 536          * @param string $term
 537          */
 538         protected function setupPage( $term ) {
 539                 $out = $this->getOutput();
 540
 541                 $this->setHeaders();
 542                 $this->outputHeader();
 543                 // TODO: Is this true? The namespace remember uses a user token
 544                 // on save.
 545                 $out->allowClickjacking();
 546                 $this->addHelpLink( 'Help:Searching' );
 547
 548                 if ( strval( $term ) !== '' ) {
 549                         $out->setPageTitle( $this->msg( 'searchresults' ) );
 550                         $out->setHTMLTitle( $this->msg( 'pagetitle' )
 551                                 ->plaintextParams( $this->msg( 'searchresults-title' )->plaintextParams( $term )->text() )
 552                                 ->inContentLanguage()->text()
 553                         );
 554                 }
 555
 556                 if ( $this->mPrefix !== '' ) {
 557                         $subtitle = $this->msg( 'search-filter-title-prefix' )->plaintextParams( $this->mPrefix );
 558                         $params = $this->powerSearchOptions();
 559                         unset( $params['prefix'] );
 560                         $params += [
 561                                 'search' => $term,
 562                                 'fulltext' => 1,
 563                         ];
 564
 565                         $subtitle .= ' (';
 566                         $subtitle .= Xml::element(
 567                                 'a',
 568                                 [
 569                                         'href' => $this->getPageTitle()->getLocalURL( $params ),
 570                                         'title' => $this->msg( 'search-filter-title-prefix-reset' )->text(),
 571                                 ],
 572                                 $this->msg( 'search-filter-title-prefix-reset' )->text()
 573                         );
 574                         $subtitle .= ')';
 575                         $out->setSubtitle( $subtitle );
 576                 }
 577
 578                 $out->addJsConfigVars( [ 'searchTerm' => $term ] );
 579                 $out->addModules( 'mediawiki.special.search' );
 580                 $out->addModuleStyles( [
 581                         'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
 582                         'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
 583                 ] );
 584         }
 585
 586         /**
 587          * Return true if current search is a power (advanced) search
 588          *
 589          * @return bool
 590          */
 591         protected function isPowerSearch() {
 592                 return $this->profile === 'advanced';
 593         }
 594
 595         /**
 596          * Extract "power search" namespace settings from the request object,
 597          * returning a list of index numbers to search.
 598          *
 599          * @param WebRequest &$request
 600          * @return array
 601          */
 602         protected function powerSearch( &$request ) {
 603                 $arr = [];
 604                 foreach ( $this->searchConfig->searchableNamespaces() as $ns => $name ) {
 605                         if ( $request->getCheck( 'ns' . $ns ) ) {
 606                                 $arr[] = $ns;
 607                         }
 608                 }
 609
 610                 return $arr;
 611         }
 612
 613         /**
 614          * Reconstruct the 'power search' options for links
 615          * TODO: Instead of exposing this publicly, could we instead expose
 616          *  a function for creating search links?
 617          *
 618          * @return array
 619          */
 620         public function powerSearchOptions() {
 621                 $opt = [];
 622                 if ( $this->isPowerSearch() ) {
 623                         foreach ( $this->namespaces as $n ) {
 624                                 $opt['ns' . $n] = 1;
 625                         }
 626                 } else {
 627                         $opt['profile'] = $this->profile;
 628                 }
 629
 630                 return $opt + $this->extraParams;
 631         }
 632
 633         /**
 634          * Save namespace preferences when we're supposed to
 635          *
 636          * @return bool Whether we wrote something
 637          */
 638         protected function saveNamespaces() {
 639                 $user = $this->getUser();
 640                 $request = $this->getRequest();
 641
 642                 if ( $user->isLoggedIn() &&
 643                         $user->matchEditToken(
 644                                 $request->getVal( 'nsRemember' ),
 645                                 'searchnamespace',
 646                                 $request
 647                         ) && !wfReadOnly()
 648                 ) {
 649                         // Reset namespace preferences: namespaces are not searched
 650                         // when they're not mentioned in the URL parameters.
 651                         foreach ( MediaWikiServices::getInstance()->getNamespaceInfo()->getValidNamespaces()
 652                                 as $n
 653                         ) {
 654                                 $user->setOption( 'searchNs' . $n, false );
 655                         }
 656                         // The request parameters include all the namespaces to be searched.
 657                         // Even if they're the same as an existing profile, they're not eaten.
 658                         foreach ( $this->namespaces as $n ) {
 659                                 $user->setOption( 'searchNs' . $n, true );
 660                         }
 661
 662                         DeferredUpdates::addCallableUpdate( function () use ( $user ) {
 663                                 $user->saveSettings();
 664                         } );
 665
 666                         return true;
 667                 }
 668
 669                 return false;
 670         }
 671
 672         /**
 673          * @return array
 674          */
 675         protected function getSearchProfiles() {
 676                 // Builds list of Search Types (profiles)
 677                 $nsAllSet = array_keys( $this->searchConfig->searchableNamespaces() );
 678                 $defaultNs = $this->searchConfig->defaultNamespaces();
 679                 $profiles = [
 680                         'default' => [
 681                                 'message' => 'searchprofile-articles',
 682                                 'tooltip' => 'searchprofile-articles-tooltip',
 683                                 'namespaces' => $defaultNs,
 684                                 'namespace-messages' => $this->searchConfig->namespacesAsText(
 685                                         $defaultNs
 686                                 ),
 687                         ],
 688                         'images' => [
 689                                 'message' => 'searchprofile-images',
 690                                 'tooltip' => 'searchprofile-images-tooltip',
 691                                 'namespaces' => [ NS_FILE ],
 692                         ],
 693                         'all' => [
 694                                 'message' => 'searchprofile-everything',
 695                                 'tooltip' => 'searchprofile-everything-tooltip',
 696                                 'namespaces' => $nsAllSet,
 697                         ],
 698                         'advanced' => [
 699                                 'message' => 'searchprofile-advanced',
 700                                 'tooltip' => 'searchprofile-advanced-tooltip',
 701                                 'namespaces' => self::NAMESPACES_CURRENT,
 702                         ]
 703                 ];
 704
 705                 Hooks::run( 'SpecialSearchProfiles', [ &$profiles ] );
 706
 707                 foreach ( $profiles as &$data ) {
 708                         if ( !is_array( $data['namespaces'] ) ) {
 709                                 continue;
 710                         }
 711                         sort( $data['namespaces'] );
 712                 }
 713
 714                 return $profiles;
 715         }
 716
 717         /**
 718          * @since 1.18
 719          *
 720          * @return SearchEngine
 721          */
 722         public function getSearchEngine() {
 723                 if ( $this->searchEngine === null ) {
 724                         $services = MediaWikiServices::getInstance();
 725                         $this->searchEngine = $this->searchEngineType ?
 726                                 $services->getSearchEngineFactory()->create( $this->searchEngineType ) :
 727                                 $services->newSearchEngine();
 728                 }
 729
 730                 return $this->searchEngine;
 731         }
 732
 733         /**
 734          * Current search profile.
 735          * @return null|string
 736          */
 737         function getProfile() {
 738                 return $this->profile;
 739         }
 740
 741         /**
 742          * Current namespaces.
 743          * @return array
 744          */
 745         function getNamespaces() {
 746                 return $this->namespaces;
 747         }
 748
 749         /**
 750          * Users of hook SpecialSearchSetupEngine can use this to
 751          * add more params to links to not lose selection when
 752          * user navigates search results.
 753          * @since 1.18
 754          *
 755          * @param string $key
 756          * @param mixed $value
 757          */
 758         public function setExtraParam( $key, $value ) {
 759                 $this->extraParams[$key] = $value;
 760         }
 761
 762         /**
 763          * The prefix value send to Special:Search using the 'prefix' URI param
 764          * It means that the user is willing to search for pages whose titles start with
 765          * this prefix value.
 766          * (Used by the InputBox extension)
 767          *
 768          * @return string
 769          */
 770         public function getPrefix() {
 771                 return $this->mPrefix;
 772         }
 773
 774         protected function getGroupName() {
 775                 return 'pages';
 776         }
 777 }