3 * Implements Special:Search
5 * Copyright © 2004 Brion Vibber <brion@pobox.com>
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.
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.
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
23 * @ingroup SpecialPage
26 use MediaWiki\MediaWikiServices
;
29 * implements Special:Search - Run text & title search and display the output
30 * @ingroup SpecialPage
32 class SpecialSearch
extends SpecialPage
{
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.
43 /** @var SearchEngine Search engine */
44 protected $searchEngine;
46 /** @var string Search engine type, if not default */
47 protected $searchEngineType;
49 /** @var array For links */
50 protected $extraParams = [];
53 * @var string The prefix url parameter. Set on the searcher and the
54 * is expected to treat it as prefix filter on titles.
61 protected $limit, $offset;
66 protected $namespaces;
76 protected $runSuggestion = true;
79 * Names of the wikis, in format: Interwiki prefix -> caption
82 protected $customCaptions;
85 * Search engine configurations.
86 * @var SearchEngineConfig
88 protected $searchConfig;
90 const NAMESPACES_CURRENT
= 'sense';
92 public function __construct() {
93 parent
::__construct( 'Search' );
94 $this->searchConfig
= MediaWikiServices
::getInstance()->getSearchEngineConfig();
102 public function execute( $par ) {
103 $request = $this->getRequest();
105 // Fetch the search term
106 $search = str_replace( "\n", " ", $request->getText( 'search' ) );
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
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 );
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',
130 $this->addHelpLink( 'Help:Searching' );
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 ) );
144 $out->addJsConfigVars( [ 'searchTerm' => $search ] );
145 $this->searchEngineType
= $request->getVal( 'srbackend' );
147 if ( $request->getVal( 'fulltext' )
148 ||
!is_null( $request->getVal( 'offset' ) )
150 $this->showResults( $search );
152 $this->goResult( $search );
157 * Set up basic search parameters from the request and user settings.
159 * @see tests/phpunit/includes/specials/SpecialSearchTest.php
161 public function load() {
162 $request = $this->getRequest();
163 list( $this->limit
, $this->offset
) = $request->getLimitOffset( 20, '' );
164 $this->mPrefix
= $request->getVal( 'prefix', '' );
166 $user = $this->getUser();
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 );
176 if ( !count( $nslist ) ) {
177 $profile = 'default';
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' ) {
190 $this->namespaces
= $nslist;
191 } elseif ( $profile === 'advanced' ) {
192 $this->namespaces
= $nslist;
194 if ( isset( $profiles[$profile]['namespaces'] ) ) {
195 $this->namespaces
= $profiles[$profile]['namespaces'];
197 // Unknown profile requested
198 $profile = 'default';
199 $this->namespaces
= $profiles['default']['namespaces'];
203 $this->fulltext
= $request->getVal( 'fulltext' );
204 $this->runSuggestion
= (bool)$request->getVal( 'runsuggestion', true );
205 $this->profile
= $profile;
209 * If an exact title match can be found, jump straight ahead to it.
211 * @param string $term
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 );
223 # If there's an exact or very near match, jump right there.
224 $title = $this->getSearchEngine()
225 ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
227 if ( !is_null( $title ) &&
228 Hooks
::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] )
230 if ( $url === null ) {
231 $url = $title->getFullURL();
233 $this->getOutput()->redirect( $url );
237 # No match, generate an edit URL
238 $title = Title
::newFromText( $term );
239 if ( !is_null( $title ) ) {
240 Hooks
::run( 'SpecialSearchNogomatch', [ &$title ] );
242 $this->showResults( $term );
246 * @param string $term
248 public function showResults( $term ) {
251 $search = $this->getSearchEngine();
252 $search->setFeatureData( 'rewrite', $this->runSuggestion
);
253 $search->setLimitOffset( $this->limit
, $this->offset
);
254 $search->setNamespaces( $this->namespaces
);
255 $search->prefix
= $this->mPrefix
;
256 $term = $search->transformSearchTerm( $term );
258 Hooks
::run( 'SpecialSearchSetupEngine', [ $this, $this->profile
, $search ] );
260 $this->setupPage( $term );
262 $out = $this->getOutput();
264 if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
265 $searchFowardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
266 if ( $searchFowardUrl ) {
267 $url = str_replace( '$1', urlencode( $term ), $searchFowardUrl );
268 $out->redirect( $url );
271 Xml
::openElement( 'fieldset' ) .
272 Xml
::element( 'legend', null, $this->msg( 'search-external' )->text() ) .
275 [ 'class' => 'mw-searchdisabled' ],
276 $this->msg( 'searchdisabled' )->text()
278 $this->msg( 'googlesearch' )->rawParams(
279 htmlspecialchars( $term ),
281 $this->msg( 'searchbutton' )->escaped()
283 Xml
::closeElement( 'fieldset' )
290 $title = Title
::newFromText( $term );
291 $showSuggestion = $title === null ||
!$title->isKnown();
292 $search->setShowSuggestion( $showSuggestion );
294 // fetch search results
295 $rewritten = $search->replacePrefixes( $term );
297 $titleMatches = $search->searchTitle( $rewritten );
298 $textMatches = $search->searchText( $rewritten );
301 if ( $textMatches instanceof Status
) {
302 $textStatus = $textMatches;
306 // did you mean... suggestions
307 $didYouMeanHtml = '';
308 if ( $showSuggestion && $textMatches && !$textStatus ) {
309 if ( $textMatches->hasRewrittenQuery() ) {
310 $didYouMeanHtml = $this->getDidYouMeanRewrittenHtml( $term, $textMatches );
311 } elseif ( $textMatches->hasSuggestion() ) {
312 $didYouMeanHtml = $this->getDidYouMeanHtml( $textMatches );
316 if ( !Hooks
::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
317 # Hook requested termination
321 // start rendering the page
326 'id' => ( $this->isPowerSearch() ?
'powersearch' : 'search' ),
328 'action' => wfScript(),
333 // Get number of results
334 $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
335 if ( $titleMatches ) {
336 $titleMatchesNum = $titleMatches->numRows();
337 $numTitleMatches = $titleMatches->getTotalHits();
339 if ( $textMatches ) {
340 $textMatchesNum = $textMatches->numRows();
341 $numTextMatches = $textMatches->getTotalHits();
343 $num = $titleMatchesNum +
$textMatchesNum;
344 $totalRes = $numTitleMatches +
$numTextMatches;
348 # This is an awful awful ID name. It's not a table, but we
349 # named it poorly from when this was a table so now we're
351 Xml
::openElement( 'div', [ 'id' => 'mw-search-top-table' ] ) .
352 $this->shortDialog( $term, $num, $totalRes ) .
353 Xml
::closeElement( 'div' ) .
354 $this->searchProfileTabs( $term ) .
355 $this->searchOptions( $term ) .
356 Xml
::closeElement( 'form' ) .
360 $filePrefix = $wgContLang->getFormattedNsText( NS_FILE
) . ':';
361 if ( trim( $term ) === '' ||
$filePrefix === trim( $term ) ) {
362 // Empty query -- straight view of search form
366 $out->addHTML( "<div class='searchresults'>" );
370 if ( $num ||
$this->offset
) {
371 // Show the create link ahead
372 $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
373 if ( $totalRes > $this->limit ||
$this->offset
) {
374 if ( $this->searchEngineType
!== null ) {
375 $this->setExtraParam( 'srbackend', $this->searchEngineType
);
377 $prevnext = $this->getLanguage()->viewPrevNext(
378 $this->getPageTitle(),
381 $this->powerSearchOptions() +
[ 'search' => $term ],
382 $this->limit +
$this->offset
>= $totalRes
386 Hooks
::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
388 $out->parserOptions()->setEditSection( false );
389 if ( $titleMatches ) {
390 if ( $numTitleMatches > 0 ) {
391 $out->wrapWikiMsg( "==$1==\n", 'titlematches' );
392 $out->addHTML( $this->showMatches( $titleMatches ) );
394 $titleMatches->free();
396 if ( $textMatches && !$textStatus ) {
397 // output appropriate heading
398 if ( $numTextMatches > 0 && $numTitleMatches > 0 ) {
399 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
400 // if no title matches the heading is redundant
401 $out->wrapWikiMsg( "==$1==\n", 'textmatches' );
405 if ( $numTextMatches > 0 ) {
406 $search->augmentSearchResults( $textMatches );
407 $out->addHTML( $this->showMatches( $textMatches ) );
410 // show secondary interwiki results if any
411 if ( $textMatches->hasInterwikiResults( SearchResultSet
::SECONDARY_RESULTS
) ) {
412 $out->addHTML( $this->showInterwiki( $textMatches->getInterwikiResults(
413 SearchResultSet
::SECONDARY_RESULTS
), $term ) );
417 $hasOtherResults = $textMatches &&
418 $textMatches->hasInterwikiResults( SearchResultSet
::INLINE_RESULTS
);
422 $out->addHTML( '<div class="error">' .
423 $textStatus->getMessage( 'search-error' ) . '</div>' );
425 if ( !$this->offset
) {
426 // If we have an offset the create link was rendered earlier in this function.
427 // This class needs a good de-spaghettification, but for now this will
429 $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
431 $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>",
432 [ $hasOtherResults ?
'search-nonefound-thiswiki' : 'search-nonefound',
433 wfEscapeWikiText( $term )
438 if ( $hasOtherResults ) {
439 foreach ( $textMatches->getInterwikiResults( SearchResultSet
::INLINE_RESULTS
)
440 as $interwiki => $interwikiResult ) {
441 if ( $interwikiResult instanceof Status ||
$interwikiResult->numRows() == 0 ) {
442 // ignore bad interwikis for now
446 $out->addHTML( $this->showMatches( $interwikiResult, $interwiki ) );
450 if ( $textMatches ) {
451 $textMatches->free();
454 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
457 $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
460 $out->addHTML( "</div>" );
462 Hooks
::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
467 * Produce wiki header for interwiki results
468 * @param string $interwiki Interwiki name
469 * @param SearchResultSet $interwikiResult The result set
472 protected function interwikiHeader( $interwiki, $interwikiResult ) {
473 // TODO: we need to figure out how to name wikis correctly
474 $wikiMsg = $this->msg( 'search-interwiki-results-' . $interwiki )->parse();
475 return "<p class=\"mw-search-interwiki-header mw-search-visualclear\">\n$wikiMsg</p>";
479 * Decide if the suggested query should be run, and it's results returned
480 * instead of the provided $textMatches
482 * @param SearchResultSet $textMatches The results of a users query
485 protected function shouldRunSuggestedQuery( SearchResultSet
$textMatches ) {
486 if ( !$this->runSuggestion ||
487 !$textMatches->hasSuggestion() ||
488 $textMatches->numRows() > 0 ||
489 $textMatches->searchContainedSyntax()
494 return $this->getConfig()->get( 'SearchRunSuggestedQuery' );
498 * Generates HTML shown to the user when we have a suggestion about a query
499 * that might give more results than their current query.
501 protected function getDidYouMeanHtml( SearchResultSet
$textMatches ) {
502 # mirror Go/Search behavior of original request ..
503 $params = [ 'search' => $textMatches->getSuggestionQuery() ];
504 if ( $this->fulltext
=== null ) {
505 $params['fulltext'] = 'Search';
507 $params['fulltext'] = $this->fulltext
;
509 $stParams = array_merge( $params, $this->powerSearchOptions() );
511 $suggest = Linker
::linkKnown(
512 $this->getPageTitle(),
513 $textMatches->getSuggestionSnippet() ?
: null,
514 [ 'id' => 'mw-search-DYM-suggestion' ],
518 # HTML of did you mean... search suggestion link
519 return Html
::rawElement(
521 [ 'class' => 'searchdidyoumean' ],
522 $this->msg( 'search-suggest' )->rawParams( $suggest )->parse()
527 * Generates HTML shown to user when their query has been internally rewritten,
528 * and the results of the rewritten query are being returned.
530 * @param string $term The users search input
531 * @param SearchResultSet $textMatches The response to the users initial search request
532 * @return string HTML linking the user to their original $term query, and the one
533 * suggested by $textMatches.
535 protected function getDidYouMeanRewrittenHtml( $term, SearchResultSet
$textMatches ) {
536 // Showing results for '$rewritten'
537 // Search instead for '$orig'
539 $params = [ 'search' => $textMatches->getQueryAfterRewrite() ];
540 if ( $this->fulltext
=== null ) {
541 $params['fulltext'] = 'Search';
543 $params['fulltext'] = $this->fulltext
;
545 $stParams = array_merge( $params, $this->powerSearchOptions() );
547 $rewritten = Linker
::linkKnown(
548 $this->getPageTitle(),
549 $textMatches->getQueryAfterRewriteSnippet() ?
: null,
550 [ 'id' => 'mw-search-DYM-rewritten' ],
554 $stParams['search'] = $term;
555 $stParams['runsuggestion'] = 0;
556 $original = Linker
::linkKnown(
557 $this->getPageTitle(),
558 htmlspecialchars( $term ),
559 [ 'id' => 'mw-search-DYM-original' ],
563 return Html
::rawElement(
565 [ 'class' => 'searchdidyoumean' ],
566 $this->msg( 'search-rewritten' )->rawParams( $rewritten, $original )->escaped()
571 * @param Title $title
572 * @param int $num The number of search results found
573 * @param null|SearchResultSet $titleMatches Results from title search
574 * @param null|SearchResultSet $textMatches Results from text search
576 protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
577 // show direct page/create link if applicable
579 // Check DBkey !== '' in case of fragment link only.
580 if ( is_null( $title ) ||
$title->getDBkey() === ''
581 ||
( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
582 ||
( $textMatches !== null && $textMatches->searchContainedSyntax() )
585 // preserve the paragraph for margins etc...
586 $this->getOutput()->addHTML( '<p></p>' );
591 $messageName = 'searchmenu-new-nocreate';
592 $linkClass = 'mw-search-createlink';
594 if ( !$title->isExternal() ) {
595 if ( $title->isKnown() ) {
596 $messageName = 'searchmenu-exists';
597 $linkClass = 'mw-search-exists';
598 } elseif ( $title->quickUserCan( 'create', $this->getUser() ) ) {
599 $messageName = 'searchmenu-new';
605 wfEscapeWikiText( $title->getPrefixedText() ),
606 Message
::numParam( $num )
608 Hooks
::run( 'SpecialSearchCreateLink', [ $title, &$params ] );
610 // Extensions using the hook might still return an empty $messageName
611 if ( $messageName ) {
612 $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
614 // preserve the paragraph for margins etc...
615 $this->getOutput()->addHTML( '<p></p>' );
620 * @param string $term
622 protected function setupPage( $term ) {
623 $out = $this->getOutput();
624 if ( strval( $term ) !== '' ) {
625 $out->setPageTitle( $this->msg( 'searchresults' ) );
626 $out->setHTMLTitle( $this->msg( 'pagetitle' )
627 ->rawParams( $this->msg( 'searchresults-title' )->rawParams( $term )->text() )
628 ->inContentLanguage()->text()
631 // add javascript specific to special:search
632 $out->addModules( 'mediawiki.special.search' );
636 * Return true if current search is a power (advanced) search
640 protected function isPowerSearch() {
641 return $this->profile
=== 'advanced';
645 * Extract "power search" namespace settings from the request object,
646 * returning a list of index numbers to search.
648 * @param WebRequest $request
651 protected function powerSearch( &$request ) {
653 foreach ( $this->searchConfig
->searchableNamespaces() as $ns => $name ) {
654 if ( $request->getCheck( 'ns' . $ns ) ) {
663 * Reconstruct the 'power search' options for links
667 protected function powerSearchOptions() {
669 if ( !$this->isPowerSearch() ) {
670 $opt['profile'] = $this->profile
;
672 foreach ( $this->namespaces
as $n ) {
677 return $opt +
$this->extraParams
;
681 * Save namespace preferences when we're supposed to
683 * @return bool Whether we wrote something
685 protected function saveNamespaces() {
686 $user = $this->getUser();
687 $request = $this->getRequest();
689 if ( $user->isLoggedIn() &&
690 $user->matchEditToken(
691 $request->getVal( 'nsRemember' ),
696 // Reset namespace preferences: namespaces are not searched
697 // when they're not mentioned in the URL parameters.
698 foreach ( MWNamespace
::getValidNamespaces() as $n ) {
699 $user->setOption( 'searchNs' . $n, false );
701 // The request parameters include all the namespaces to be searched.
702 // Even if they're the same as an existing profile, they're not eaten.
703 foreach ( $this->namespaces
as $n ) {
704 $user->setOption( 'searchNs' . $n, true );
707 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
708 $user->saveSettings();
718 * Show whole set of results
720 * @param SearchResultSet $matches
721 * @param string $interwiki Interwiki name
725 protected function showMatches( $matches, $interwiki = null ) {
728 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
730 $result = $matches->next();
731 $pos = $this->offset
;
733 if ( $result && $interwiki ) {
734 $out .= $this->interwikiHeader( $interwiki, $matches );
737 $out .= "<ul class='mw-search-results'>\n";
739 $out .= $this->showHit( $result, $terms, $pos++
);
740 $result = $matches->next();
744 // convert the whole thing to desired language variant
745 $out = $wgContLang->convert( $out );
751 * Format a single hit result
753 * @param SearchResult $result
754 * @param array $terms Terms to highlight
755 * @param int $position Position within the search results, including offset.
759 protected function showHit( SearchResult
$result, $terms, $position ) {
761 if ( $result->isBrokenTitle() ) {
765 $title = $result->getTitle();
767 $titleSnippet = $result->getTitleSnippet();
769 if ( $titleSnippet == '' ) {
770 $titleSnippet = null;
773 $link_t = clone $title;
776 Hooks
::run( 'ShowSearchHitTitle',
777 [ &$link_t, &$titleSnippet, $result, $terms, $this, &$query ] );
779 $link = Linker
::linkKnown(
782 [ 'data-serp-pos' => $position ], // HTML attributes
786 // If page content is not readable, just return the title.
787 // This is not quite safe, but better than showing excerpts from non-readable pages
788 // Note that hiding the entry entirely would screw up paging.
789 if ( !$title->userCan( 'read', $this->getUser() ) ) {
790 return "<li>{$link}</li>\n";
793 // If the page doesn't *exist*... our search index is out of date.
794 // The least confusing at this point is to drop the result.
795 // You may get less results, but... oh well. :P
796 if ( $result->isMissingRevision() ) {
800 // format redirects / relevant sections
801 $redirectTitle = $result->getRedirectTitle();
802 $redirectText = $result->getRedirectSnippet();
803 $sectionTitle = $result->getSectionTitle();
804 $sectionText = $result->getSectionSnippet();
805 $categorySnippet = $result->getCategorySnippet();
808 if ( !is_null( $redirectTitle ) ) {
809 if ( $redirectText == '' ) {
810 $redirectText = null;
813 $redirect = "<span class='searchalttitle'>" .
814 $this->msg( 'search-redirect' )->rawParams(
815 Linker
::linkKnown( $redirectTitle, $redirectText ) )->text() .
820 if ( !is_null( $sectionTitle ) ) {
821 if ( $sectionText == '' ) {
825 $section = "<span class='searchalttitle'>" .
826 $this->msg( 'search-section' )->rawParams(
827 Linker
::linkKnown( $sectionTitle, $sectionText ) )->text() .
832 if ( $categorySnippet ) {
833 $category = "<span class='searchalttitle'>" .
834 $this->msg( 'search-category' )->rawParams( $categorySnippet )->text() .
838 // format text extract
839 $extract = "<div class='searchresult'>" . $result->getTextSnippet( $terms ) . "</div>";
841 $lang = $this->getLanguage();
843 // format description
844 $byteSize = $result->getByteSize();
845 $wordCount = $result->getWordCount();
846 $timestamp = $result->getTimestamp();
847 $size = $this->msg( 'search-result-size', $lang->formatSize( $byteSize ) )
848 ->numParams( $wordCount )->escaped();
850 if ( $title->getNamespace() == NS_CATEGORY
) {
851 $cat = Category
::newFromTitle( $title );
852 $size = $this->msg( 'search-result-category-size' )
853 ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
857 $date = $lang->userTimeAndDate( $timestamp, $this->getUser() );
860 // Include a thumbnail for media files...
861 if ( $title->getNamespace() == NS_FILE
) {
862 $img = $result->getFile();
863 $img = $img ?
: wfFindFile( $title );
864 if ( $result->isFileMatch() ) {
865 $fileMatch = "<span class='searchalttitle'>" .
866 $this->msg( 'search-file-match' )->escaped() . "</span>";
869 $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
871 $desc = $this->msg( 'parentheses' )->rawParams( $img->getShortDesc() )->escaped();
872 // Float doesn't seem to interact well with the bullets.
873 // Table messes up vertical alignment of the bullets.
874 // Bullets are therefore disabled (didn't look great anyway).
876 '<table class="searchResultImage">' .
878 '<td style="width: 120px; text-align: center; vertical-align: top;">' .
879 $thumb->toHtml( [ 'desc-link' => true ] ) .
881 '<td style="vertical-align: top;">' .
882 "{$link} {$redirect} {$category} {$section} {$fileMatch}" .
884 "<div class='mw-search-result-data'>{$desc} - {$date}</div>" .
897 if ( Hooks
::run( 'ShowSearchHit', [
898 $this, $result, $terms,
899 &$link, &$redirect, &$section, &$extract,
900 &$score, &$size, &$date, &$related,
903 $html = "<li><div class='mw-search-result-heading'>" .
904 "{$link} {$redirect} {$category} {$section} {$fileMatch}</div> {$extract}\n" .
905 "<div class='mw-search-result-data'>{$size} - {$date}</div>" .
913 * Extract custom captions from search-interwiki-custom message
915 protected function getCustomCaptions() {
916 if ( is_null( $this->customCaptions
) ) {
917 $this->customCaptions
= [];
918 // format per line <iwprefix>:<caption>
919 $customLines = explode( "\n", $this->msg( 'search-interwiki-custom' )->text() );
920 foreach ( $customLines as $line ) {
921 $parts = explode( ":", $line, 2 );
922 if ( count( $parts ) == 2 ) { // validate line
923 $this->customCaptions
[$parts[0]] = $parts[1];
930 * Show results from other wikis
932 * @param SearchResultSet|array $matches
933 * @param string $query
937 protected function showInterwiki( $matches, $query ) {
940 $out = "<div id='mw-search-interwiki'><div id='mw-search-interwiki-caption'>" .
941 $this->msg( 'search-interwiki-caption' )->text() . "</div>\n";
942 $out .= "<ul class='mw-search-iwresults'>\n";
944 // work out custom project captions
945 $this->getCustomCaptions();
947 if ( !is_array( $matches ) ) {
948 $matches = [ $matches ];
951 foreach ( $matches as $set ) {
953 $result = $set->next();
955 $out .= $this->showInterwikiHit( $result, $prev, $query );
956 $prev = $result->getInterwikiPrefix();
957 $result = $set->next();
961 // @todo Should support paging in a non-confusing way (not sure how though, maybe via ajax)..
962 $out .= "</ul></div>\n";
964 // convert the whole thing to desired language variant
965 $out = $wgContLang->convert( $out );
971 * Show single interwiki link
973 * @param SearchResult $result
974 * @param string $lastInterwiki
975 * @param string $query
979 protected function showInterwikiHit( $result, $lastInterwiki, $query ) {
981 if ( $result->isBrokenTitle() ) {
985 $title = $result->getTitle();
987 $titleSnippet = $result->getTitleSnippet();
989 if ( $titleSnippet == '' ) {
990 $titleSnippet = null;
993 $link = Linker
::linkKnown(
998 // format redirect if any
999 $redirectTitle = $result->getRedirectTitle();
1000 $redirectText = $result->getRedirectSnippet();
1002 if ( !is_null( $redirectTitle ) ) {
1003 if ( $redirectText == '' ) {
1004 $redirectText = null;
1007 $redirect = "<span class='searchalttitle'>" .
1008 $this->msg( 'search-redirect' )->rawParams(
1009 Linker
::linkKnown( $redirectTitle, $redirectText ) )->text() .
1014 // display project name
1015 if ( is_null( $lastInterwiki ) ||
$lastInterwiki != $title->getInterwiki() ) {
1016 if ( array_key_exists( $title->getInterwiki(), $this->customCaptions
) ) {
1017 // captions from 'search-interwiki-custom'
1018 $caption = $this->customCaptions
[$title->getInterwiki()];
1020 // default is to show the hostname of the other wiki which might suck
1021 // if there are many wikis on one hostname
1022 $parsed = wfParseUrl( $title->getFullURL() );
1023 $caption = $this->msg( 'search-interwiki-default', $parsed['host'] )->text();
1025 // "more results" link (special page stuff could be localized, but we might not know target lang)
1026 $searchTitle = Title
::newFromText( $title->getInterwiki() . ":Special:Search" );
1027 $searchLink = Linker
::linkKnown(
1029 $this->msg( 'search-interwiki-more' )->text(),
1033 'fulltext' => 'Search'
1036 $out .= "</ul><div class='mw-search-interwiki-project'><span class='mw-search-interwiki-more'>
1037 {$searchLink}</span>{$caption}</div>\n<ul>";
1040 $out .= "<li>{$link} {$redirect}</li>\n";
1046 * Generates the power search box at [[Special:Search]]
1048 * @param string $term Search term
1049 * @param array $opts
1050 * @return string HTML form
1052 protected function powerSearchBox( $term, $opts ) {
1055 // Groups namespaces into rows according to subject
1057 foreach ( $this->searchConfig
->searchableNamespaces() as $namespace => $name ) {
1058 $subject = MWNamespace
::getSubject( $namespace );
1059 if ( !array_key_exists( $subject, $rows ) ) {
1060 $rows[$subject] = "";
1063 $name = $wgContLang->getConverter()->convertNamespace( $namespace );
1064 if ( $name == '' ) {
1065 $name = $this->msg( 'blanknamespace' )->text();
1069 Xml
::openElement( 'td' ) .
1073 "mw-search-ns{$namespace}",
1074 in_array( $namespace, $this->namespaces
)
1076 Xml
::closeElement( 'td' );
1079 $rows = array_values( $rows );
1080 $numRows = count( $rows );
1082 // Lays out namespaces in multiple floating two-column tables so they'll
1083 // be arranged nicely while still accommodating different screen widths
1084 $namespaceTables = '';
1085 for ( $i = 0; $i < $numRows; $i +
= 4 ) {
1086 $namespaceTables .= Xml
::openElement( 'table' );
1088 for ( $j = $i; $j < $i +
4 && $j < $numRows; $j++
) {
1089 $namespaceTables .= Xml
::tags( 'tr', null, $rows[$j] );
1092 $namespaceTables .= Xml
::closeElement( 'table' );
1095 $showSections = [ 'namespaceTables' => $namespaceTables ];
1097 Hooks
::run( 'SpecialSearchPowerBox', [ &$showSections, $term, $opts ] );
1100 foreach ( $opts as $key => $value ) {
1101 $hidden .= Html
::hidden( $key, $value );
1104 # Stuff to feed saveNamespaces()
1106 $user = $this->getUser();
1107 if ( $user->isLoggedIn() ) {
1108 $remember .= Xml
::checkLabel(
1109 $this->msg( 'powersearch-remember' )->text(),
1111 'mw-search-powersearch-remember',
1113 // The token goes here rather than in a hidden field so it
1114 // is only sent when necessary (not every form submission).
1115 [ 'value' => $user->getEditToken(
1122 // Return final output
1123 return Xml
::openElement( 'fieldset', [ 'id' => 'mw-searchoptions' ] ) .
1124 Xml
::element( 'legend', null, $this->msg( 'powersearch-legend' )->text() ) .
1125 Xml
::tags( 'h4', null, $this->msg( 'powersearch-ns' )->parse() ) .
1126 Xml
::element( 'div', [ 'id' => 'mw-search-togglebox' ], '', false ) .
1127 Xml
::element( 'div', [ 'class' => 'divider' ], '', false ) .
1128 implode( Xml
::element( 'div', [ 'class' => 'divider' ], '', false ), $showSections ) .
1130 Xml
::element( 'div', [ 'class' => 'divider' ], '', false ) .
1132 Xml
::closeElement( 'fieldset' );
1138 protected function getSearchProfiles() {
1139 // Builds list of Search Types (profiles)
1140 $nsAllSet = array_keys( $this->searchConfig
->searchableNamespaces() );
1141 $defaultNs = $this->searchConfig
->defaultNamespaces();
1144 'message' => 'searchprofile-articles',
1145 'tooltip' => 'searchprofile-articles-tooltip',
1146 'namespaces' => $defaultNs,
1147 'namespace-messages' => $this->searchConfig
->namespacesAsText(
1152 'message' => 'searchprofile-images',
1153 'tooltip' => 'searchprofile-images-tooltip',
1154 'namespaces' => [ NS_FILE
],
1157 'message' => 'searchprofile-everything',
1158 'tooltip' => 'searchprofile-everything-tooltip',
1159 'namespaces' => $nsAllSet,
1162 'message' => 'searchprofile-advanced',
1163 'tooltip' => 'searchprofile-advanced-tooltip',
1164 'namespaces' => self
::NAMESPACES_CURRENT
,
1168 Hooks
::run( 'SpecialSearchProfiles', [ &$profiles ] );
1170 foreach ( $profiles as &$data ) {
1171 if ( !is_array( $data['namespaces'] ) ) {
1174 sort( $data['namespaces'] );
1181 * @param string $term
1184 protected function searchProfileTabs( $term ) {
1185 $out = Html
::element( 'div', [ 'class' => 'mw-search-visualclear' ] ) .
1186 Xml
::openElement( 'div', [ 'class' => 'mw-search-profile-tabs' ] );
1189 if ( $this->startsWithImage( $term ) ) {
1191 $bareterm = substr( $term, strpos( $term, ':' ) +
1 );
1194 $profiles = $this->getSearchProfiles();
1195 $lang = $this->getLanguage();
1197 // Outputs XML for Search Types
1198 $out .= Xml
::openElement( 'div', [ 'class' => 'search-types' ] );
1199 $out .= Xml
::openElement( 'ul' );
1200 foreach ( $profiles as $id => $profile ) {
1201 if ( !isset( $profile['parameters'] ) ) {
1202 $profile['parameters'] = [];
1204 $profile['parameters']['profile'] = $id;
1206 $tooltipParam = isset( $profile['namespace-messages'] ) ?
1207 $lang->commaList( $profile['namespace-messages'] ) : null;
1211 'class' => $this->profile
=== $id ?
'current' : 'normal'
1213 $this->makeSearchLink(
1216 $this->msg( $profile['message'] )->text(),
1217 $this->msg( $profile['tooltip'], $tooltipParam )->text(),
1218 $profile['parameters']
1222 $out .= Xml
::closeElement( 'ul' );
1223 $out .= Xml
::closeElement( 'div' );
1224 $out .= Xml
::element( 'div', [ 'style' => 'clear:both' ], '', false );
1225 $out .= Xml
::closeElement( 'div' );
1231 * @param string $term Search term
1234 protected function searchOptions( $term ) {
1237 $opts['profile'] = $this->profile
;
1239 if ( $this->isPowerSearch() ) {
1240 $out .= $this->powerSearchBox( $term, $opts );
1243 Hooks
::run( 'SpecialSearchProfileForm', [ $this, &$form, $this->profile
, $term, $opts ] );
1251 * @param string $term
1252 * @param int $resultsShown
1253 * @param int $totalNum
1256 protected function shortDialog( $term, $resultsShown, $totalNum ) {
1257 $searchWidget = new MediaWiki\Widget\
SearchInputWidget( [
1258 'id' => 'searchText',
1260 'autofocus' => trim( $term ) === '',
1262 'dataLocation' => 'content',
1263 'infusable' => true,
1266 $layout = new OOUI\
ActionFieldLayout( $searchWidget, new OOUI\
ButtonInputWidget( [
1268 'label' => $this->msg( 'searchbutton' )->text(),
1269 'flags' => [ 'progressive', 'primary' ],
1275 Html
::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
1276 Html
::hidden( 'profile', $this->profile
) .
1277 Html
::hidden( 'fulltext', 'Search' ) .
1281 if ( $totalNum > 0 && $this->offset
< $totalNum ) {
1282 $top = $this->msg( 'search-showingresults' )
1283 ->numParams( $this->offset +
1, $this->offset +
$resultsShown, $totalNum )
1284 ->numParams( $resultsShown )
1286 $out .= Xml
::tags( 'div', [ 'class' => 'results-info' ], $top );
1293 * Make a search link with some target namespaces
1295 * @param string $term
1296 * @param array $namespaces Ignored
1297 * @param string $label Link's text
1298 * @param string $tooltip Link's tooltip
1299 * @param array $params Query string parameters
1300 * @return string HTML fragment
1302 protected function makeSearchLink( $term, $namespaces, $label, $tooltip, $params = [] ) {
1304 foreach ( $namespaces as $n ) {
1305 $opt['ns' . $n] = 1;
1308 $stParams = array_merge(
1311 'fulltext' => $this->msg( 'search' )->text()
1316 return Xml
::element(
1319 'href' => $this->getPageTitle()->getLocalURL( $stParams ),
1327 * Check if query starts with image: prefix
1329 * @param string $term The string to check
1332 protected function startsWithImage( $term ) {
1335 $parts = explode( ':', $term );
1336 if ( count( $parts ) > 1 ) {
1337 return $wgContLang->getNsIndex( $parts[0] ) == NS_FILE
;
1344 * Check if query starts with all: prefix
1346 * @param string $term The string to check
1349 protected function startsWithAll( $term ) {
1351 $allkeyword = $this->msg( 'searchall' )->inContentLanguage()->text();
1353 $parts = explode( ':', $term );
1354 if ( count( $parts ) > 1 ) {
1355 return $parts[0] == $allkeyword;
1364 * @return SearchEngine
1366 public function getSearchEngine() {
1367 if ( $this->searchEngine
=== null ) {
1368 $this->searchEngine
= $this->searchEngineType ?
1369 MediaWikiServices
::getInstance()->getSearchEngineFactory()->create( $this->searchEngineType
) :
1370 MediaWikiServices
::getInstance()->newSearchEngine();
1373 return $this->searchEngine
;
1377 * Current search profile.
1378 * @return null|string
1380 function getProfile() {
1381 return $this->profile
;
1385 * Current namespaces.
1388 function getNamespaces() {
1389 return $this->namespaces
;
1393 * Users of hook SpecialSearchSetupEngine can use this to
1394 * add more params to links to not lose selection when
1395 * user navigates search results.
1398 * @param string $key
1399 * @param mixed $value
1401 public function setExtraParam( $key, $value ) {
1402 $this->extraParams
[$key] = $value;
1405 protected function getGroupName() {