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
  28 /**
  29  * implements Special:Search - Run text & title search and display the output
  30  * @ingroup SpecialPage
  31  */
  32 class SpecialSearch extends SpecialPage {
  33         /**
  34          * Current search profile. Search profile is just a name that identifies
  35          * the active search tab on the search page (content, discussions...)
  36          * For users tt replaces the set of enabled namespaces from the query
  37          * string when applicable. Extensions can add new profiles with hooks
  38          * with custom search options just for that profile.
  39          * @var null|string
  40          */
  41         protected $profile;
  42
  43         /** @var SearchEngine Search engine */
  44         protected $searchEngine;
  45
  46         /** @var string Search engine type, if not default */
  47         protected $searchEngineType;
  48
  49         /** @var array For links */
  50         protected $extraParams = [];
  51
  52         /**
  53          * @var string The prefix url parameter. Set on the searcher and the
  54          * is expected to treat it as prefix filter on titles.
  55          */
  56         protected $mPrefix;
  57
  58         /**
  59          * @var int
  60          */
  61         protected $limit, $offset;
  62
  63         /**
  64          * @var array
  65          */
  66         protected $namespaces;
  67
  68         /**
  69          * @var string
  70          */
  71         protected $fulltext;
  72
  73         /**
  74          * @var bool
  75          */
  76         protected $runSuggestion = true;
  77
  78         /**
  79          * Names of the wikis, in format: Interwiki prefix -> caption
  80          * @var array
  81          */
  82         protected $customCaptions;
  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
 105                 // Fetch the search term
 106                 $search = str_replace( "\n", " ", $request->getText( 'search' ) );
 107
 108                 // Historically search terms have been accepted not only in the search query
 109                 // parameter, but also as part of the primary url. This can have PII implications
 110                 // in releasing page view data. As such issue a 301 redirect to the correct
 111                 // URL.
 112                 if ( strlen( $par ) && !strlen( $search ) ) {
 113                         $query = $request->getValues();
 114                         unset( $query['title'] );
 115                         // Strip underscores from title parameter; most of the time we'll want
 116                         // text form here. But don't strip underscores from actual text params!
 117                         $query['search'] = str_replace( '_', ' ', $par );
 118                         $this->getOutput()->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
 119                         return;
 120                 }
 121
 122                 $this->setHeaders();
 123                 $this->outputHeader();
 124                 $out = $this->getOutput();
 125                 $out->allowClickjacking();
 126                 $out->addModuleStyles( [
 127                         'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
 128                         'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
 129                 ] );
 130                 $this->addHelpLink( 'Help:Searching' );
 131
 132                 $this->load();
 133                 if ( !is_null( $request->getVal( 'nsRemember' ) ) ) {
 134                         $this->saveNamespaces();
 135                         // Remove the token from the URL to prevent the user from inadvertently
 136                         // exposing it (e.g. by pasting it into a public wiki page) or undoing
 137                         // later settings changes (e.g. by reloading the page).
 138                         $query = $request->getValues();
 139                         unset( $query['title'], $query['nsRemember'] );
 140                         $out->redirect( $this->getPageTitle()->getFullURL( $query ) );
 141                         return;
 142                 }
 143
 144                 $out->addJsConfigVars( [ 'searchTerm' => $search ] );
 145                 $this->searchEngineType = $request->getVal( 'srbackend' );
 146
 147                 if ( $request->getVal( 'fulltext' )
 148                         || !is_null( $request->getVal( 'offset' ) )
 149                 ) {
 150                         $this->showResults( $search );
 151                 } else {
 152                         $this->goResult( $search );
 153                 }
 154         }
 155
 156         /**
 157          * Set up basic search parameters from the request and user settings.
 158          *
 159          * @see tests/phpunit/includes/specials/SpecialSearchTest.php
 160          */
 161         public function load() {
 162                 $request = $this->getRequest();
 163                 list( $this->limit, $this->offset ) = $request->getLimitOffset( 20, '' );
 164                 $this->mPrefix = $request->getVal( 'prefix', '' );
 165
 166                 $user = $this->getUser();
 167
 168                 # Extract manually requested namespaces
 169                 $nslist = $this->powerSearch( $request );
 170                 if ( !count( $nslist ) ) {
 171                         # Fallback to user preference
 172                         $nslist = $this->searchConfig->userNamespaces( $user );
 173                 }
 174
 175                 $profile = null;
 176                 if ( !count( $nslist ) ) {
 177                         $profile = 'default';
 178                 }
 179
 180                 $profile = $request->getVal( 'profile', $profile );
 181                 $profiles = $this->getSearchProfiles();
 182                 if ( $profile === null ) {
 183                         // BC with old request format
 184                         $profile = 'advanced';
 185                         foreach ( $profiles as $key => $data ) {
 186                                 if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) {
 187                                         $profile = $key;
 188                                 }
 189                         }
 190                         $this->namespaces = $nslist;
 191                 } elseif ( $profile === 'advanced' ) {
 192                         $this->namespaces = $nslist;
 193                 } else {
 194                         if ( isset( $profiles[$profile]['namespaces'] ) ) {
 195                                 $this->namespaces = $profiles[$profile]['namespaces'];
 196                         } else {
 197                                 // Unknown profile requested
 198                                 $profile = 'default';
 199                                 $this->namespaces = $profiles['default']['namespaces'];
 200                         }
 201                 }
 202
 203                 $this->fulltext = $request->getVal( 'fulltext' );
 204                 $this->runSuggestion = (bool)$request->getVal( 'runsuggestion', true );
 205                 $this->profile = $profile;
 206         }
 207
 208         /**
 209          * If an exact title match can be found, jump straight ahead to it.
 210          *
 211          * @param string $term
 212          */
 213         public function goResult( $term ) {
 214                 $this->setupPage( $term );
 215                 # Try to go to page as entered.
 216                 $title = Title::newFromText( $term );
 217                 # If the string cannot be used to create a title
 218                 if ( is_null( $title ) ) {
 219                         $this->showResults( $term );
 220
 221                         return;
 222                 }
 223                 # If there's an exact or very near match, jump right there.
 224                 $title = $this->getSearchEngine()
 225                         ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
 226
 227                 if ( !is_null( $title ) &&
 228                         Hooks::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] )
 229                 ) {
 230                         if ( $url === null ) {
 231                                 $url = $title->getFullURL();
 232                         }
 233                         $this->getOutput()->redirect( $url );
 234
 235                         return;
 236                 }
 237                 $this->showResults( $term );
 238         }
 239
 240         /**
 241          * @param string $term
 242          */
 243         public function showResults( $term ) {
 244                 global $wgContLang;
 245
 246                 $search = $this->getSearchEngine();
 247                 $search->setFeatureData( 'rewrite', $this->runSuggestion );
 248                 $search->setLimitOffset( $this->limit, $this->offset );
 249                 $search->setNamespaces( $this->namespaces );
 250                 $search->prefix = $this->mPrefix;
 251                 $term = $search->transformSearchTerm( $term );
 252
 253                 Hooks::run( 'SpecialSearchSetupEngine', [ $this, $this->profile, $search ] );
 254
 255                 $this->setupPage( $term );
 256
 257                 $out = $this->getOutput();
 258
 259                 if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
 260                         $searchFowardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
 261                         if ( $searchFowardUrl ) {
 262                                 $url = str_replace( '$1', urlencode( $term ), $searchFowardUrl );
 263                                 $out->redirect( $url );
 264                         } else {
 265                                 $out->addHTML(
 266                                         Xml::openElement( 'fieldset' ) .
 267                                         Xml::element( 'legend', null, $this->msg( 'search-external' )->text() ) .
 268                                         Xml::element(
 269                                                 'p',
 270                                                 [ 'class' => 'mw-searchdisabled' ],
 271                                                 $this->msg( 'searchdisabled' )->text()
 272                                         ) .
 273                                         $this->msg( 'googlesearch' )->rawParams(
 274                                                 htmlspecialchars( $term ),
 275                                                 'UTF-8',
 276                                                 $this->msg( 'searchbutton' )->escaped()
 277                                         )->text() .
 278                                         Xml::closeElement( 'fieldset' )
 279                                 );
 280                         }
 281
 282                         return;
 283                 }
 284
 285                 $title = Title::newFromText( $term );
 286                 $showSuggestion = $title === null || !$title->isKnown();
 287                 $search->setShowSuggestion( $showSuggestion );
 288
 289                 // fetch search results
 290                 $rewritten = $search->replacePrefixes( $term );
 291
 292                 $titleMatches = $search->searchTitle( $rewritten );
 293                 $textMatches = $search->searchText( $rewritten );
 294
 295                 $textStatus = null;
 296                 if ( $textMatches instanceof Status ) {
 297                         $textStatus = $textMatches;
 298                         $textMatches = $textStatus->getValue();
 299                 }
 300
 301                 // did you mean... suggestions
 302                 $didYouMeanHtml = '';
 303                 if ( $showSuggestion && $textMatches ) {
 304                         if ( $textMatches->hasRewrittenQuery() ) {
 305                                 $didYouMeanHtml = $this->getDidYouMeanRewrittenHtml( $term, $textMatches );
 306                         } elseif ( $textMatches->hasSuggestion() ) {
 307                                 $didYouMeanHtml = $this->getDidYouMeanHtml( $textMatches );
 308                         }
 309                 }
 310
 311                 if ( !Hooks::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
 312                         # Hook requested termination
 313                         return;
 314                 }
 315
 316                 // start rendering the page
 317                 $out->addHTML(
 318                         Xml::openElement(
 319                                 'form',
 320                                 [
 321                                         'id' => ( $this->isPowerSearch() ? 'powersearch' : 'search' ),
 322                                         'method' => 'get',
 323                                         'action' => wfScript(),
 324                                 ]
 325                         )
 326                 );
 327
 328                 // Get number of results
 329                 $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
 330                 if ( $titleMatches ) {
 331                         $titleMatchesNum = $titleMatches->numRows();
 332                         $numTitleMatches = $titleMatches->getTotalHits();
 333                 }
 334                 if ( $textMatches ) {
 335                         $textMatchesNum = $textMatches->numRows();
 336                         $numTextMatches = $textMatches->getTotalHits();
 337                 }
 338                 $num = $titleMatchesNum + $textMatchesNum;
 339                 $totalRes = $numTitleMatches + $numTextMatches;
 340
 341                 $out->enableOOUI();
 342                 $out->addHTML(
 343                         # This is an awful awful ID name. It's not a table, but we
 344                         # named it poorly from when this was a table so now we're
 345                         # stuck with it
 346                         Xml::openElement( 'div', [ 'id' => 'mw-search-top-table' ] ) .
 347                         $this->shortDialog( $term, $num, $totalRes ) .
 348                         Xml::closeElement( 'div' ) .
 349                         $this->searchProfileTabs( $term ) .
 350                         $this->searchOptions( $term ) .
 351                         Xml::closeElement( 'form' ) .
 352                         $didYouMeanHtml
 353                 );
 354
 355                 $filePrefix = $wgContLang->getFormattedNsText( NS_FILE ) . ':';
 356                 if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
 357                         // Empty query -- straight view of search form
 358                         return;
 359                 }
 360
 361                 $out->addHTML( "<div class='searchresults'>" );
 362
 363                 $hasErrors = $textStatus && $textStatus->getErrors();
 364                 if ( $hasErrors ) {
 365                         list( $error, $warning ) = $textStatus->splitByErrorType();
 366                         if ( $error->getErrors() ) {
 367                                 $out->addHTML( Html::rawElement(
 368                                         'div',
 369                                         [ 'class' => 'errorbox' ],
 370                                         $error->getHTML( 'search-error' )
 371                                 ) );
 372                         }
 373                         if ( $warning->getErrors() ) {
 374                                 $out->addHTML( Html::rawElement(
 375                                         'div',
 376                                         [ 'class' => 'warningbox' ],
 377                                         $warning->getHTML( 'search-warning' )
 378                                 ) );
 379                         }
 380                 }
 381
 382                 // prev/next links
 383                 $prevnext = null;
 384                 if ( $num || $this->offset ) {
 385                         // Show the create link ahead
 386                         $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
 387                         if ( $totalRes > $this->limit || $this->offset ) {
 388                                 if ( $this->searchEngineType !== null ) {
 389                                         $this->setExtraParam( 'srbackend', $this->searchEngineType );
 390                                 }
 391                                 $prevnext = $this->getLanguage()->viewPrevNext(
 392                                         $this->getPageTitle(),
 393                                         $this->offset,
 394                                         $this->limit,
 395                                         $this->powerSearchOptions() + [ 'search' => $term ],
 396                                         $this->limit + $this->offset >= $totalRes
 397                                 );
 398                         }
 399                 }
 400                 Hooks::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
 401
 402                 $out->parserOptions()->setEditSection( false );
 403                 if ( $titleMatches ) {
 404                         if ( $numTitleMatches > 0 ) {
 405                                 $out->wrapWikiMsg( "==$1==\n", 'titlematches' );
 406                                 $out->addHTML( $this->showMatches( $titleMatches ) );
 407                         }
 408                         $titleMatches->free();
 409                 }
 410
 411                 if ( $textMatches ) {
 412                         // output appropriate heading
 413                         if ( $numTextMatches > 0 && $numTitleMatches > 0 ) {
 414                                 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
 415                                 // if no title matches the heading is redundant
 416                                 $out->wrapWikiMsg( "==$1==\n", 'textmatches' );
 417                         }
 418
 419                         // show results
 420                         if ( $numTextMatches > 0 ) {
 421                                 $search->augmentSearchResults( $textMatches );
 422                                 $out->addHTML( $this->showMatches( $textMatches ) );
 423                         }
 424
 425                         // show secondary interwiki results if any
 426                         if ( $textMatches->hasInterwikiResults( SearchResultSet::SECONDARY_RESULTS ) ) {
 427                                 $out->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(
 428                                                 SearchResultSet::SECONDARY_RESULTS ), $term ) );
 429                         }
 430                 }
 431
 432                 $hasOtherResults = $textMatches &&
 433                         $textMatches->hasInterwikiResults( SearchResultSet::INLINE_RESULTS );
 434
 435                 // If we have no results and we have not already displayed an error message
 436                 if ( $num === 0 && !$hasErrors ) {
 437                         if ( !$this->offset ) {
 438                                 // If we have an offset the create link was rendered earlier in this function.
 439                                 // This class needs a good de-spaghettification, but for now this will
 440                                 // do the job.
 441                                 $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
 442                         }
 443                         $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
 444                                 $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
 445                                 wfEscapeWikiText( $term )
 446                         ] );
 447                 }
 448
 449                 if ( $hasOtherResults ) {
 450                         foreach ( $textMatches->getInterwikiResults( SearchResultSet::INLINE_RESULTS )
 451                                                 as $interwiki => $interwikiResult ) {
 452                                 if ( $interwikiResult instanceof Status || $interwikiResult->numRows() == 0 ) {
 453                                         // ignore bad interwikis for now
 454                                         continue;
 455                                 }
 456                                 // TODO: wiki header
 457                                 $out->addHTML( $this->showMatches( $interwikiResult, $interwiki ) );
 458                         }
 459                 }
 460
 461                 if ( $textMatches ) {
 462                         $textMatches->free();
 463                 }
 464
 465                 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
 466
 467                 if ( $prevnext ) {
 468                         $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
 469                 }
 470
 471                 $out->addHTML( "</div>" );
 472
 473                 Hooks::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
 474         }
 475
 476         /**
 477          * Produce wiki header for interwiki results
 478          * @param string $interwiki Interwiki name
 479          * @param SearchResultSet $interwikiResult The result set
 480          * @return string
 481          */
 482         protected function interwikiHeader( $interwiki, $interwikiResult ) {
 483                 // TODO: we need to figure out how to name wikis correctly
 484                 $wikiMsg = $this->msg( 'search-interwiki-results-' . $interwiki )->parse();
 485                 return "<p class=\"mw-search-interwiki-header mw-search-visualclear\">\n$wikiMsg</p>";
 486         }
 487
 488         /**
 489          * Generates HTML shown to the user when we have a suggestion about a query
 490          * that might give more results than their current query.
 491          */
 492         protected function getDidYouMeanHtml( SearchResultSet $textMatches ) {
 493                 # mirror Go/Search behavior of original request ..
 494                 $params = [ 'search' => $textMatches->getSuggestionQuery() ];
 495                 if ( $this->fulltext === null ) {
 496                         $params['fulltext'] = 'Search';
 497                 } else {
 498                         $params['fulltext'] = $this->fulltext;
 499                 }
 500                 $stParams = array_merge( $params, $this->powerSearchOptions() );
 501
 502                 $linkRenderer = $this->getLinkRenderer();
 503
 504                 $snippet = $textMatches->getSuggestionSnippet() ?: null;
 505                 if ( $snippet !== null ) {
 506                         $snippet = new HtmlArmor( $snippet );
 507                 }
 508
 509                 $suggest = $linkRenderer->makeKnownLink(
 510                         $this->getPageTitle(),
 511                         $snippet,
 512                         [ 'id' => 'mw-search-DYM-suggestion' ],
 513                         $stParams
 514                 );
 515
 516                 # HTML of did you mean... search suggestion link
 517                 return Html::rawElement(
 518                         'div',
 519                         [ 'class' => 'searchdidyoumean' ],
 520                         $this->msg( 'search-suggest' )->rawParams( $suggest )->parse()
 521                 );
 522         }
 523
 524         /**
 525          * Generates HTML shown to user when their query has been internally rewritten,
 526          * and the results of the rewritten query are being returned.
 527          *
 528          * @param string $term The users search input
 529          * @param SearchResultSet $textMatches The response to the users initial search request
 530          * @return string HTML linking the user to their original $term query, and the one
 531          *  suggested by $textMatches.
 532          */
 533         protected function getDidYouMeanRewrittenHtml( $term, SearchResultSet $textMatches ) {
 534                 // Showing results for '$rewritten'
 535                 // Search instead for '$orig'
 536
 537                 $params = [ 'search' => $textMatches->getQueryAfterRewrite() ];
 538                 if ( $this->fulltext === null ) {
 539                         $params['fulltext'] = 'Search';
 540                 } else {
 541                         $params['fulltext'] = $this->fulltext;
 542                 }
 543                 $stParams = array_merge( $params, $this->powerSearchOptions() );
 544
 545                 $linkRenderer = $this->getLinkRenderer();
 546
 547                 $snippet = $textMatches->getQueryAfterRewriteSnippet() ?: null;
 548                 if ( $snippet !== null ) {
 549                         $snippet = new HtmlArmor( $snippet );
 550                 }
 551
 552                 $rewritten = $linkRenderer->makeKnownLink(
 553                         $this->getPageTitle(),
 554                         $snippet,
 555                         [ 'id' => 'mw-search-DYM-rewritten' ],
 556                         $stParams
 557                 );
 558
 559                 $stParams['search'] = $term;
 560                 $stParams['runsuggestion'] = 0;
 561                 $original = $linkRenderer->makeKnownLink(
 562                         $this->getPageTitle(),
 563                         $term,
 564                         [ 'id' => 'mw-search-DYM-original' ],
 565                         $stParams
 566                 );
 567
 568                 return Html::rawElement(
 569                         'div',
 570                         [ 'class' => 'searchdidyoumean' ],
 571                         $this->msg( 'search-rewritten' )->rawParams( $rewritten, $original )->escaped()
 572                 );
 573         }
 574
 575         /**
 576          * @param Title $title
 577          * @param int $num The number of search results found
 578          * @param null|SearchResultSet $titleMatches Results from title search
 579          * @param null|SearchResultSet $textMatches Results from text search
 580          */
 581         protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
 582                 // show direct page/create link if applicable
 583
 584                 // Check DBkey !== '' in case of fragment link only.
 585                 if ( is_null( $title ) || $title->getDBkey() === ''
 586                         || ( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
 587                         || ( $textMatches !== null && $textMatches->searchContainedSyntax() )
 588                 ) {
 589                         // invalid title
 590                         // preserve the paragraph for margins etc...
 591                         $this->getOutput()->addHTML( '<p></p>' );
 592
 593                         return;
 594                 }
 595
 596                 $messageName = 'searchmenu-new-nocreate';
 597                 $linkClass = 'mw-search-createlink';
 598
 599                 if ( !$title->isExternal() ) {
 600                         if ( $title->isKnown() ) {
 601                                 $messageName = 'searchmenu-exists';
 602                                 $linkClass = 'mw-search-exists';
 603                         } elseif ( $title->quickUserCan( 'create', $this->getUser() ) ) {
 604                                 $messageName = 'searchmenu-new';
 605                         }
 606                 }
 607
 608                 $params = [
 609                         $messageName,
 610                         wfEscapeWikiText( $title->getPrefixedText() ),
 611                         Message::numParam( $num )
 612                 ];
 613                 Hooks::run( 'SpecialSearchCreateLink', [ $title, &$params ] );
 614
 615                 // Extensions using the hook might still return an empty $messageName
 616                 if ( $messageName ) {
 617                         $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
 618                 } else {
 619                         // preserve the paragraph for margins etc...
 620                         $this->getOutput()->addHTML( '<p></p>' );
 621                 }
 622         }
 623
 624         /**
 625          * @param string $term
 626          */
 627         protected function setupPage( $term ) {
 628                 $out = $this->getOutput();
 629                 if ( strval( $term ) !== '' ) {
 630                         $out->setPageTitle( $this->msg( 'searchresults' ) );
 631                         $out->setHTMLTitle( $this->msg( 'pagetitle' )
 632                                 ->rawParams( $this->msg( 'searchresults-title' )->rawParams( $term )->text() )
 633                                 ->inContentLanguage()->text()
 634                         );
 635                 }
 636                 // add javascript specific to special:search
 637                 $out->addModules( 'mediawiki.special.search' );
 638         }
 639
 640         /**
 641          * Return true if current search is a power (advanced) search
 642          *
 643          * @return bool
 644          */
 645         protected function isPowerSearch() {
 646                 return $this->profile === 'advanced';
 647         }
 648
 649         /**
 650          * Extract "power search" namespace settings from the request object,
 651          * returning a list of index numbers to search.
 652          *
 653          * @param WebRequest $request
 654          * @return array
 655          */
 656         protected function powerSearch( &$request ) {
 657                 $arr = [];
 658                 foreach ( $this->searchConfig->searchableNamespaces() as $ns => $name ) {
 659                         if ( $request->getCheck( 'ns' . $ns ) ) {
 660                                 $arr[] = $ns;
 661                         }
 662                 }
 663
 664                 return $arr;
 665         }
 666
 667         /**
 668          * Reconstruct the 'power search' options for links
 669          *
 670          * @return array
 671          */
 672         protected function powerSearchOptions() {
 673                 $opt = [];
 674                 if ( !$this->isPowerSearch() ) {
 675                         $opt['profile'] = $this->profile;
 676                 } else {
 677                         foreach ( $this->namespaces as $n ) {
 678                                 $opt['ns' . $n] = 1;
 679                         }
 680                 }
 681
 682                 return $opt + $this->extraParams;
 683         }
 684
 685         /**
 686          * Save namespace preferences when we're supposed to
 687          *
 688          * @return bool Whether we wrote something
 689          */
 690         protected function saveNamespaces() {
 691                 $user = $this->getUser();
 692                 $request = $this->getRequest();
 693
 694                 if ( $user->isLoggedIn() &&
 695                         $user->matchEditToken(
 696                                 $request->getVal( 'nsRemember' ),
 697                                 'searchnamespace',
 698                                 $request
 699                         ) && !wfReadOnly()
 700                 ) {
 701                         // Reset namespace preferences: namespaces are not searched
 702                         // when they're not mentioned in the URL parameters.
 703                         foreach ( MWNamespace::getValidNamespaces() as $n ) {
 704                                 $user->setOption( 'searchNs' . $n, false );
 705                         }
 706                         // The request parameters include all the namespaces to be searched.
 707                         // Even if they're the same as an existing profile, they're not eaten.
 708                         foreach ( $this->namespaces as $n ) {
 709                                 $user->setOption( 'searchNs' . $n, true );
 710                         }
 711
 712                         DeferredUpdates::addCallableUpdate( function () use ( $user ) {
 713                                 $user->saveSettings();
 714                         } );
 715
 716                         return true;
 717                 }
 718
 719                 return false;
 720         }
 721
 722         /**
 723          * Show whole set of results
 724          *
 725          * @param SearchResultSet $matches
 726          * @param string $interwiki Interwiki name
 727          *
 728          * @return string
 729          */
 730         protected function showMatches( $matches, $interwiki = null ) {
 731                 global $wgContLang;
 732
 733                 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
 734                 $out = '';
 735                 $result = $matches->next();
 736                 $pos = $this->offset;
 737
 738                 if ( $result && $interwiki ) {
 739                         $out .= $this->interwikiHeader( $interwiki, $matches );
 740                 }
 741
 742                 $out .= "<ul class='mw-search-results'>\n";
 743                 while ( $result ) {
 744                         $out .= $this->showHit( $result, $terms, $pos++ );
 745                         $result = $matches->next();
 746                 }
 747                 $out .= "</ul>\n";
 748
 749                 // convert the whole thing to desired language variant
 750                 $out = $wgContLang->convert( $out );
 751
 752                 return $out;
 753         }
 754
 755         /**
 756          * Format a single hit result
 757          *
 758          * @param SearchResult $result
 759          * @param array $terms Terms to highlight
 760          * @param int $position Position within the search results, including offset.
 761          *
 762          * @return string
 763          */
 764         protected function showHit( SearchResult $result, $terms, $position ) {
 765                 if ( $result->isBrokenTitle() ) {
 766                         return '';
 767                 }
 768
 769                 $title = $result->getTitle();
 770
 771                 $titleSnippet = $result->getTitleSnippet();
 772
 773                 if ( $titleSnippet == '' ) {
 774                         $titleSnippet = null;
 775                 }
 776
 777                 $link_t = clone $title;
 778                 $query = [];
 779
 780                 Hooks::run( 'ShowSearchHitTitle',
 781                         [ &$link_t, &$titleSnippet, $result, $terms, $this, &$query ] );
 782
 783                 $linkRenderer = $this->getLinkRenderer();
 784
 785                 if ( $titleSnippet !== null ) {
 786                         $titleSnippet = new HtmlArmor( $titleSnippet );
 787                 }
 788
 789                 $link = $linkRenderer->makeKnownLink(
 790                         $link_t,
 791                         $titleSnippet,
 792                         [ 'data-serp-pos' => $position ], // HTML attributes
 793                         $query
 794                 );
 795
 796                 // If page content is not readable, just return the title.
 797                 // This is not quite safe, but better than showing excerpts from non-readable pages
 798                 // Note that hiding the entry entirely would screw up paging.
 799                 if ( !$title->userCan( 'read', $this->getUser() ) ) {
 800                         return "<li>{$link}</li>\n";
 801                 }
 802
 803                 // If the page doesn't *exist*... our search index is out of date.
 804                 // The least confusing at this point is to drop the result.
 805                 // You may get less results, but... oh well. :P
 806                 if ( $result->isMissingRevision() ) {
 807                         return '';
 808                 }
 809
 810                 // format redirects / relevant sections
 811                 $redirectTitle = $result->getRedirectTitle();
 812                 $redirectText = $result->getRedirectSnippet();
 813                 $sectionTitle = $result->getSectionTitle();
 814                 $sectionText = $result->getSectionSnippet();
 815                 $categorySnippet = $result->getCategorySnippet();
 816
 817                 $redirect = '';
 818                 if ( !is_null( $redirectTitle ) ) {
 819                         if ( $redirectText == '' ) {
 820                                 $redirectText = null;
 821                         }
 822
 823                         if ( $redirectText !== null ) {
 824                                 $redirectText = new HtmlArmor( $redirectText );
 825                         }
 826
 827                         $redirect = "<span class='searchalttitle'>" .
 828                                 $this->msg( 'search-redirect' )->rawParams(
 829                                         $linkRenderer->makeKnownLink( $redirectTitle, $redirectText ) )->text() .
 830                                 "</span>";
 831                 }
 832
 833                 $section = '';
 834                 if ( !is_null( $sectionTitle ) ) {
 835                         if ( $sectionText == '' ) {
 836                                 $sectionText = null;
 837                         }
 838
 839                         if ( $sectionText !== null ) {
 840                                 $sectionText = new HtmlArmor( $sectionText );
 841                         }
 842
 843                         $section = "<span class='searchalttitle'>" .
 844                                 $this->msg( 'search-section' )->rawParams(
 845                                         $linkRenderer->makeKnownLink( $sectionTitle, $sectionText ) )->text() .
 846                                 "</span>";
 847                 }
 848
 849                 $category = '';
 850                 if ( $categorySnippet ) {
 851                         $category = "<span class='searchalttitle'>" .
 852                                 $this->msg( 'search-category' )->rawParams( $categorySnippet )->text() .
 853                                 "</span>";
 854                 }
 855
 856                 // format text extract
 857                 $extract = "<div class='searchresult'>" . $result->getTextSnippet( $terms ) . "</div>";
 858
 859                 $lang = $this->getLanguage();
 860
 861                 // format description
 862                 $byteSize = $result->getByteSize();
 863                 $wordCount = $result->getWordCount();
 864                 $timestamp = $result->getTimestamp();
 865                 $size = $this->msg( 'search-result-size', $lang->formatSize( $byteSize ) )
 866                         ->numParams( $wordCount )->escaped();
 867
 868                 if ( $title->getNamespace() == NS_CATEGORY ) {
 869                         $cat = Category::newFromTitle( $title );
 870                         $size = $this->msg( 'search-result-category-size' )
 871                                 ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
 872                                 ->escaped();
 873                 }
 874
 875                 $date = $lang->userTimeAndDate( $timestamp, $this->getUser() );
 876
 877                 $fileMatch = '';
 878                 // Include a thumbnail for media files...
 879                 if ( $title->getNamespace() == NS_FILE ) {
 880                         $img = $result->getFile();
 881                         $img = $img ?: wfFindFile( $title );
 882                         if ( $result->isFileMatch() ) {
 883                                 $fileMatch = "<span class='searchalttitle'>" .
 884                                         $this->msg( 'search-file-match' )->escaped() . "</span>";
 885                         }
 886                         if ( $img ) {
 887                                 $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
 888                                 if ( $thumb ) {
 889                                         $desc = $this->msg( 'parentheses' )->rawParams( $img->getShortDesc() )->escaped();
 890                                         // Float doesn't seem to interact well with the bullets.
 891                                         // Table messes up vertical alignment of the bullets.
 892                                         // Bullets are therefore disabled (didn't look great anyway).
 893                                         return "<li>" .
 894                                                 '<table class="searchResultImage">' .
 895                                                 '<tr>' .
 896                                                 '<td style="width: 120px; text-align: center; vertical-align: top;">' .
 897                                                 $thumb->toHtml( [ 'desc-link' => true ] ) .
 898                                                 '</td>' .
 899                                                 '<td style="vertical-align: top;">' .
 900                                                 "{$link} {$redirect} {$category} {$section} {$fileMatch}" .
 901                                                 $extract .
 902                                                 "<div class='mw-search-result-data'>{$desc} - {$date}</div>" .
 903                                                 '</td>' .
 904                                                 '</tr>' .
 905                                                 '</table>' .
 906                                                 "</li>\n";
 907                                 }
 908                         }
 909                 }
 910
 911                 $html = null;
 912
 913                 $score = '';
 914                 $related = '';
 915                 if ( Hooks::run( 'ShowSearchHit', [
 916                         $this, $result, $terms,
 917                         &$link, &$redirect, &$section, &$extract,
 918                         &$score, &$size, &$date, &$related,
 919                         &$html
 920                 ] ) ) {
 921                         $html = "<li><div class='mw-search-result-heading'>" .
 922                                 "{$link} {$redirect} {$category} {$section} {$fileMatch}</div> {$extract}\n" .
 923                                 "<div class='mw-search-result-data'>{$size} - {$date}</div>" .
 924                                 "</li>\n";
 925                 }
 926
 927                 return $html;
 928         }
 929
 930         /**
 931          * Extract custom captions from search-interwiki-custom message
 932          */
 933         protected function getCustomCaptions() {
 934                 if ( is_null( $this->customCaptions ) ) {
 935                         $this->customCaptions = [];
 936                         // format per line <iwprefix>:<caption>
 937                         $customLines = explode( "\n", $this->msg( 'search-interwiki-custom' )->text() );
 938                         foreach ( $customLines as $line ) {
 939                                 $parts = explode( ":", $line, 2 );
 940                                 if ( count( $parts ) == 2 ) { // validate line
 941                                         $this->customCaptions[$parts[0]] = $parts[1];
 942                                 }
 943                         }
 944                 }
 945         }
 946
 947         /**
 948          * Show results from other wikis
 949          *
 950          * @param SearchResultSet|array $matches
 951          * @param string $query
 952          *
 953          * @return string
 954          */
 955         protected function showInterwiki( $matches, $query ) {
 956                 global $wgContLang;
 957
 958                 $out = "<div id='mw-search-interwiki'><div id='mw-search-interwiki-caption'>" .
 959                         $this->msg( 'search-interwiki-caption' )->text() . "</div>\n";
 960                 $out .= "<ul class='mw-search-iwresults'>\n";
 961
 962                 // work out custom project captions
 963                 $this->getCustomCaptions();
 964
 965                 if ( !is_array( $matches ) ) {
 966                         $matches = [ $matches ];
 967                 }
 968
 969                 foreach ( $matches as $set ) {
 970                         $prev = null;
 971                         $result = $set->next();
 972                         while ( $result ) {
 973                                 $out .= $this->showInterwikiHit( $result, $prev, $query );
 974                                 $prev = $result->getInterwikiPrefix();
 975                                 $result = $set->next();
 976                         }
 977                 }
 978
 979                 // @todo Should support paging in a non-confusing way (not sure how though, maybe via ajax)..
 980                 $out .= "</ul></div>\n";
 981
 982                 // convert the whole thing to desired language variant
 983                 $out = $wgContLang->convert( $out );
 984
 985                 return $out;
 986         }
 987
 988         /**
 989          * Show single interwiki link
 990          *
 991          * @param SearchResult $result
 992          * @param string $lastInterwiki
 993          * @param string $query
 994          *
 995          * @return string
 996          */
 997         protected function showInterwikiHit( $result, $lastInterwiki, $query ) {
 998                 if ( $result->isBrokenTitle() ) {
 999                         return '';
1000                 }
1001
1002                 $linkRenderer = $this->getLinkRenderer();
1003
1004                 $title = $result->getTitle();
1005
1006                 $titleSnippet = $result->getTitleSnippet();
1007
1008                 if ( $titleSnippet == '' ) {
1009                         $titleSnippet = null;
1010                 }
1011
1012                 if ( $titleSnippet !== null ) {
1013                         $titleSnippet = new HtmlArmor( $titleSnippet );
1014                 }
1015
1016                 $link = $linkRenderer->makeKnownLink(
1017                         $title,
1018                         $titleSnippet
1019                 );
1020
1021                 // format redirect if any
1022                 $redirectTitle = $result->getRedirectTitle();
1023                 $redirectText = $result->getRedirectSnippet();
1024                 $redirect = '';
1025                 if ( !is_null( $redirectTitle ) ) {
1026                         if ( $redirectText == '' ) {
1027                                 $redirectText = null;
1028                         }
1029
1030                         if ( $redirectText !== null ) {
1031                                 $redirectText = new HtmlArmor( $redirectText );
1032                         }
1033
1034                         $redirect = "<span class='searchalttitle'>" .
1035                                 $this->msg( 'search-redirect' )->rawParams(
1036                                         $linkRenderer->makeKnownLink( $redirectTitle, $redirectText ) )->text() .
1037                                 "</span>";
1038                 }
1039
1040                 $out = "";
1041                 // display project name
1042                 if ( is_null( $lastInterwiki ) || $lastInterwiki != $title->getInterwiki() ) {
1043                         if ( array_key_exists( $title->getInterwiki(), $this->customCaptions ) ) {
1044                                 // captions from 'search-interwiki-custom'
1045                                 $caption = $this->customCaptions[$title->getInterwiki()];
1046                         } else {
1047                                 // default is to show the hostname of the other wiki which might suck
1048                                 // if there are many wikis on one hostname
1049                                 $parsed = wfParseUrl( $title->getFullURL() );
1050                                 $caption = $this->msg( 'search-interwiki-default', $parsed['host'] )->text();
1051                         }
1052                         // "more results" link (special page stuff could be localized, but we might not know target lang)
1053                         $searchTitle = Title::newFromText( $title->getInterwiki() . ":Special:Search" );
1054                         $searchLink = $linkRenderer->makeKnownLink(
1055                                 $searchTitle,
1056                                 $this->msg( 'search-interwiki-more' )->text(),
1057                                 [],
1058                                 [
1059                                         'search' => $query,
1060                                         'fulltext' => 'Search'
1061                                 ]
1062                         );
1063                         $out .= "</ul><div class='mw-search-interwiki-project'><span class='mw-search-interwiki-more'>
1064                                 {$searchLink}</span>{$caption}</div>\n<ul>";
1065                 }
1066
1067                 $out .= "<li>{$link} {$redirect}</li>\n";
1068
1069                 return $out;
1070         }
1071
1072         /**
1073          * Generates the power search box at [[Special:Search]]
1074          *
1075          * @param string $term Search term
1076          * @param array $opts
1077          * @return string HTML form
1078          */
1079         protected function powerSearchBox( $term, $opts ) {
1080                 global $wgContLang;
1081
1082                 // Groups namespaces into rows according to subject
1083                 $rows = [];
1084                 foreach ( $this->searchConfig->searchableNamespaces() as $namespace => $name ) {
1085                         $subject = MWNamespace::getSubject( $namespace );
1086                         if ( !array_key_exists( $subject, $rows ) ) {
1087                                 $rows[$subject] = "";
1088                         }
1089
1090                         $name = $wgContLang->getConverter()->convertNamespace( $namespace );
1091                         if ( $name == '' ) {
1092                                 $name = $this->msg( 'blanknamespace' )->text();
1093                         }
1094
1095                         $rows[$subject] .=
1096                                 Xml::openElement( 'td' ) .
1097                                 Xml::checkLabel(
1098                                         $name,
1099                                         "ns{$namespace}",
1100                                         "mw-search-ns{$namespace}",
1101                                         in_array( $namespace, $this->namespaces )
1102                                 ) .
1103                                 Xml::closeElement( 'td' );
1104                 }
1105
1106                 $rows = array_values( $rows );
1107                 $numRows = count( $rows );
1108
1109                 // Lays out namespaces in multiple floating two-column tables so they'll
1110                 // be arranged nicely while still accommodating different screen widths
1111                 $namespaceTables = '';
1112                 for ( $i = 0; $i < $numRows; $i += 4 ) {
1113                         $namespaceTables .= Xml::openElement( 'table' );
1114
1115                         for ( $j = $i; $j < $i + 4 && $j < $numRows; $j++ ) {
1116                                 $namespaceTables .= Xml::tags( 'tr', null, $rows[$j] );
1117                         }
1118
1119                         $namespaceTables .= Xml::closeElement( 'table' );
1120                 }
1121
1122                 $showSections = [ 'namespaceTables' => $namespaceTables ];
1123
1124                 Hooks::run( 'SpecialSearchPowerBox', [ &$showSections, $term, $opts ] );
1125
1126                 $hidden = '';
1127                 foreach ( $opts as $key => $value ) {
1128                         $hidden .= Html::hidden( $key, $value );
1129                 }
1130
1131                 # Stuff to feed saveNamespaces()
1132                 $remember = '';
1133                 $user = $this->getUser();
1134                 if ( $user->isLoggedIn() ) {
1135                         $remember .= Xml::checkLabel(
1136                                 $this->msg( 'powersearch-remember' )->text(),
1137                                 'nsRemember',
1138                                 'mw-search-powersearch-remember',
1139                                 false,
1140                                 // The token goes here rather than in a hidden field so it
1141                                 // is only sent when necessary (not every form submission).
1142                                 [ 'value' => $user->getEditToken(
1143                                         'searchnamespace',
1144                                         $this->getRequest()
1145                                 ) ]
1146                         );
1147                 }
1148
1149                 // Return final output
1150                 return Xml::openElement( 'fieldset', [ 'id' => 'mw-searchoptions' ] ) .
1151                         Xml::element( 'legend', null, $this->msg( 'powersearch-legend' )->text() ) .
1152                         Xml::tags( 'h4', null, $this->msg( 'powersearch-ns' )->parse() ) .
1153                         Xml::element( 'div', [ 'id' => 'mw-search-togglebox' ], '', false ) .
1154                         Xml::element( 'div', [ 'class' => 'divider' ], '', false ) .
1155                         implode( Xml::element( 'div', [ 'class' => 'divider' ], '', false ), $showSections ) .
1156                         $hidden .
1157                         Xml::element( 'div', [ 'class' => 'divider' ], '', false ) .
1158                         $remember .
1159                         Xml::closeElement( 'fieldset' );
1160         }
1161
1162         /**
1163          * @return array
1164          */
1165         protected function getSearchProfiles() {
1166                 // Builds list of Search Types (profiles)
1167                 $nsAllSet = array_keys( $this->searchConfig->searchableNamespaces() );
1168                 $defaultNs = $this->searchConfig->defaultNamespaces();
1169                 $profiles = [
1170                         'default' => [
1171                                 'message' => 'searchprofile-articles',
1172                                 'tooltip' => 'searchprofile-articles-tooltip',
1173                                 'namespaces' => $defaultNs,
1174                                 'namespace-messages' => $this->searchConfig->namespacesAsText(
1175                                         $defaultNs
1176                                 ),
1177                         ],
1178                         'images' => [
1179                                 'message' => 'searchprofile-images',
1180                                 'tooltip' => 'searchprofile-images-tooltip',
1181                                 'namespaces' => [ NS_FILE ],
1182                         ],
1183                         'all' => [
1184                                 'message' => 'searchprofile-everything',
1185                                 'tooltip' => 'searchprofile-everything-tooltip',
1186                                 'namespaces' => $nsAllSet,
1187                         ],
1188                         'advanced' => [
1189                                 'message' => 'searchprofile-advanced',
1190                                 'tooltip' => 'searchprofile-advanced-tooltip',
1191                                 'namespaces' => self::NAMESPACES_CURRENT,
1192                         ]
1193                 ];
1194
1195                 Hooks::run( 'SpecialSearchProfiles', [ &$profiles ] );
1196
1197                 foreach ( $profiles as &$data ) {
1198                         if ( !is_array( $data['namespaces'] ) ) {
1199                                 continue;
1200                         }
1201                         sort( $data['namespaces'] );
1202                 }
1203
1204                 return $profiles;
1205         }
1206
1207         /**
1208          * @param string $term
1209          * @return string
1210          */
1211         protected function searchProfileTabs( $term ) {
1212                 $out = Html::element( 'div', [ 'class' => 'mw-search-visualclear' ] ) .
1213                         Xml::openElement( 'div', [ 'class' => 'mw-search-profile-tabs' ] );
1214
1215                 $bareterm = $term;
1216                 if ( $this->startsWithImage( $term ) ) {
1217                         // Deletes prefixes
1218                         $bareterm = substr( $term, strpos( $term, ':' ) + 1 );
1219                 }
1220
1221                 $profiles = $this->getSearchProfiles();
1222                 $lang = $this->getLanguage();
1223
1224                 // Outputs XML for Search Types
1225                 $out .= Xml::openElement( 'div', [ 'class' => 'search-types' ] );
1226                 $out .= Xml::openElement( 'ul' );
1227                 foreach ( $profiles as $id => $profile ) {
1228                         if ( !isset( $profile['parameters'] ) ) {
1229                                 $profile['parameters'] = [];
1230                         }
1231                         $profile['parameters']['profile'] = $id;
1232
1233                         $tooltipParam = isset( $profile['namespace-messages'] ) ?
1234                                 $lang->commaList( $profile['namespace-messages'] ) : null;
1235                         $out .= Xml::tags(
1236                                 'li',
1237                                 [
1238                                         'class' => $this->profile === $id ? 'current' : 'normal'
1239                                 ],
1240                                 $this->makeSearchLink(
1241                                         $bareterm,
1242                                         [],
1243                                         $this->msg( $profile['message'] )->text(),
1244                                         $this->msg( $profile['tooltip'], $tooltipParam )->text(),
1245                                         $profile['parameters']
1246                                 )
1247                         );
1248                 }
1249                 $out .= Xml::closeElement( 'ul' );
1250                 $out .= Xml::closeElement( 'div' );
1251                 $out .= Xml::element( 'div', [ 'style' => 'clear:both' ], '', false );
1252                 $out .= Xml::closeElement( 'div' );
1253
1254                 return $out;
1255         }
1256
1257         /**
1258          * @param string $term Search term
1259          * @return string
1260          */
1261         protected function searchOptions( $term ) {
1262                 $out = '';
1263                 $opts = [];
1264                 $opts['profile'] = $this->profile;
1265
1266                 if ( $this->isPowerSearch() ) {
1267                         $out .= $this->powerSearchBox( $term, $opts );
1268                 } else {
1269                         $form = '';
1270                         Hooks::run( 'SpecialSearchProfileForm', [ $this, &$form, $this->profile, $term, $opts ] );
1271                         $out .= $form;
1272                 }
1273
1274                 return $out;
1275         }
1276
1277         /**
1278          * @param string $term
1279          * @param int $resultsShown
1280          * @param int $totalNum
1281          * @return string
1282          */
1283         protected function shortDialog( $term, $resultsShown, $totalNum ) {
1284                 $searchWidget = new MediaWiki\Widget\SearchInputWidget( [
1285                         'id' => 'searchText',
1286                         'name' => 'search',
1287                         'autofocus' => trim( $term ) === '',
1288                         'value' => $term,
1289                         'dataLocation' => 'content',
1290                         'infusable' => true,
1291                 ] );
1292
1293                 $layout = new OOUI\ActionFieldLayout( $searchWidget, new OOUI\ButtonInputWidget( [
1294                         'type' => 'submit',
1295                         'label' => $this->msg( 'searchbutton' )->text(),
1296                         'flags' => [ 'progressive', 'primary' ],
1297                 ] ), [
1298                         'align' => 'top',
1299                 ] );
1300
1301                 $out =
1302                         Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
1303                         Html::hidden( 'profile', $this->profile ) .
1304                         Html::hidden( 'fulltext', 'Search' ) .
1305                         $layout;
1306
1307                 // Results-info
1308                 if ( $totalNum > 0 && $this->offset < $totalNum ) {
1309                         $top = $this->msg( 'search-showingresults' )
1310                                 ->numParams( $this->offset + 1, $this->offset + $resultsShown, $totalNum )
1311                                 ->numParams( $resultsShown )
1312                                 ->parse();
1313                         $out .= Xml::tags( 'div', [ 'class' => 'results-info' ], $top );
1314                 }
1315
1316                 return $out;
1317         }
1318
1319         /**
1320          * Make a search link with some target namespaces
1321          *
1322          * @param string $term
1323          * @param array $namespaces Ignored
1324          * @param string $label Link's text
1325          * @param string $tooltip Link's tooltip
1326          * @param array $params Query string parameters
1327          * @return string HTML fragment
1328          */
1329         protected function makeSearchLink( $term, $namespaces, $label, $tooltip, $params = [] ) {
1330                 $opt = $params;
1331                 foreach ( $namespaces as $n ) {
1332                         $opt['ns' . $n] = 1;
1333                 }
1334
1335                 $stParams = array_merge(
1336                         [
1337                                 'search' => $term,
1338                                 'fulltext' => $this->msg( 'search' )->text()
1339                         ],
1340                         $opt
1341                 );
1342
1343                 return Xml::element(
1344                         'a',
1345                         [
1346                                 'href' => $this->getPageTitle()->getLocalURL( $stParams ),
1347                                 'title' => $tooltip
1348                         ],
1349                         $label
1350                 );
1351         }
1352
1353         /**
1354          * Check if query starts with image: prefix
1355          *
1356          * @param string $term The string to check
1357          * @return bool
1358          */
1359         protected function startsWithImage( $term ) {
1360                 global $wgContLang;
1361
1362                 $parts = explode( ':', $term );
1363                 if ( count( $parts ) > 1 ) {
1364                         return $wgContLang->getNsIndex( $parts[0] ) == NS_FILE;
1365                 }
1366
1367                 return false;
1368         }
1369
1370         /**
1371          * @since 1.18
1372          *
1373          * @return SearchEngine
1374          */
1375         public function getSearchEngine() {
1376                 if ( $this->searchEngine === null ) {
1377                         $this->searchEngine = $this->searchEngineType ?
1378                                 MediaWikiServices::getInstance()->getSearchEngineFactory()->create( $this->searchEngineType ) :
1379                                 MediaWikiServices::getInstance()->newSearchEngine();
1380                 }
1381
1382                 return $this->searchEngine;
1383         }
1384
1385         /**
1386          * Current search profile.
1387          * @return null|string
1388          */
1389         function getProfile() {
1390                 return $this->profile;
1391         }
1392
1393         /**
1394          * Current namespaces.
1395          * @return array
1396          */
1397         function getNamespaces() {
1398                 return $this->namespaces;
1399         }
1400
1401         /**
1402          * Users of hook SpecialSearchSetupEngine can use this to
1403          * add more params to links to not lose selection when
1404          * user navigates search results.
1405          * @since 1.18
1406          *
1407          * @param string $key
1408          * @param mixed $value
1409          */
1410         public function setExtraParam( $key, $value ) {
1411                 $this->extraParams[$key] = $value;
1412         }
1413
1414         protected function getGroupName() {
1415                 return 'pages';
1416         }
1417 }