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