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
;
27 use MediaWiki\Widget\Search\BasicSearchResultSetWidget
;
28 use MediaWiki\Widget\Search\FullSearchResultWidget
;
29 use MediaWiki\Widget\Search\InterwikiSearchResultWidget
;
30 use MediaWiki\Widget\Search\InterwikiSearchResultSetWidget
;
31 use MediaWiki\Widget\Search\SimpleSearchResultWidget
;
32 use MediaWiki\Widget\Search\SimpleSearchResultSetWidget
;
35 * implements Special:Search - Run text & title search and display the output
36 * @ingroup SpecialPage
38 class SpecialSearch
extends SpecialPage
{
40 * Current search profile. Search profile is just a name that identifies
41 * the active search tab on the search page (content, discussions...)
42 * For users tt replaces the set of enabled namespaces from the query
43 * string when applicable. Extensions can add new profiles with hooks
44 * with custom search options just for that profile.
49 /** @var SearchEngine Search engine */
50 protected $searchEngine;
52 /** @var string Search engine type, if not default */
53 protected $searchEngineType;
55 /** @var array For links */
56 protected $extraParams = [];
59 * @var string The prefix url parameter. Set on the searcher and the
60 * is expected to treat it as prefix filter on titles.
67 protected $limit, $offset;
72 protected $namespaces;
82 protected $runSuggestion = true;
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();
104 $out = $this->getOutput();
106 // Fetch the search term
107 $term = str_replace( "\n", " ", $request->getText( 'search' ) );
109 // Historically search terms have been accepted not only in the search query
110 // parameter, but also as part of the primary url. This can have PII implications
111 // in releasing page view data. As such issue a 301 redirect to the correct
113 if ( strlen( $par ) && !strlen( $term ) ) {
114 $query = $request->getValues();
115 unset( $query['title'] );
116 // Strip underscores from title parameter; most of the time we'll want
117 // text form here. But don't strip underscores from actual text params!
118 $query['search'] = str_replace( '_', ' ', $par );
119 $out->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
123 // Need to load selected namespaces before handling nsRemember
125 // TODO: This performs database actions on GET request, which is going to
126 // be a problem for our multi-datacenter work.
127 if ( !is_null( $request->getVal( 'nsRemember' ) ) ) {
128 $this->saveNamespaces();
129 // Remove the token from the URL to prevent the user from inadvertently
130 // exposing it (e.g. by pasting it into a public wiki page) or undoing
131 // later settings changes (e.g. by reloading the page).
132 $query = $request->getValues();
133 unset( $query['title'], $query['nsRemember'] );
134 $out->redirect( $this->getPageTitle()->getFullURL( $query ) );
138 $this->searchEngineType
= $request->getVal( 'srbackend' );
140 !$request->getVal( 'fulltext' ) &&
141 $request->getVal( 'offset' ) === null
143 $url = $this->goResult( $term );
144 if ( $url !== null ) {
146 $out->redirect( $url );
149 // No match. If it could plausibly be a title
150 // run the No go match hook.
151 $title = Title
::newFromText( $term );
152 if ( !is_null( $title ) ) {
153 Hooks
::run( 'SpecialSearchNogomatch', [ &$title ] );
157 $this->setupPage( $term );
159 if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
160 $searchForwardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
161 if ( $searchForwardUrl ) {
162 $url = str_replace( '$1', urlencode( $term ), $searchForwardUrl );
163 $out->redirect( $url );
168 $this->msg( 'search-external' )->escaped() .
170 "<p class='mw-searchdisabled'>" .
171 $this->msg( 'searchdisabled' )->escaped() .
173 $this->msg( 'googlesearch' )->rawParams(
174 htmlspecialchars( $term ),
176 $this->msg( 'searchbutton' )->escaped()
185 $this->showResults( $term );
189 * Set up basic search parameters from the request and user settings.
191 * @see tests/phpunit/includes/specials/SpecialSearchTest.php
193 public function load() {
194 $request = $this->getRequest();
195 list( $this->limit
, $this->offset
) = $request->getLimitOffset( 20, '' );
196 $this->mPrefix
= $request->getVal( 'prefix', '' );
198 $user = $this->getUser();
200 # Extract manually requested namespaces
201 $nslist = $this->powerSearch( $request );
202 if ( !count( $nslist ) ) {
203 # Fallback to user preference
204 $nslist = $this->searchConfig
->userNamespaces( $user );
208 if ( !count( $nslist ) ) {
209 $profile = 'default';
212 $profile = $request->getVal( 'profile', $profile );
213 $profiles = $this->getSearchProfiles();
214 if ( $profile === null ) {
215 // BC with old request format
216 $profile = 'advanced';
217 foreach ( $profiles as $key => $data ) {
218 if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) {
222 $this->namespaces
= $nslist;
223 } elseif ( $profile === 'advanced' ) {
224 $this->namespaces
= $nslist;
226 if ( isset( $profiles[$profile]['namespaces'] ) ) {
227 $this->namespaces
= $profiles[$profile]['namespaces'];
229 // Unknown profile requested
230 $profile = 'default';
231 $this->namespaces
= $profiles['default']['namespaces'];
235 $this->fulltext
= $request->getVal( 'fulltext' );
236 $this->runSuggestion
= (bool)$request->getVal( 'runsuggestion', true );
237 $this->profile
= $profile;
241 * If an exact title match can be found, jump straight ahead to it.
243 * @param string $term
244 * @return string|null The url to redirect to, or null if no redirect.
246 public function goResult( $term ) {
247 # If the string cannot be used to create a title
248 if ( is_null( Title
::newFromText( $term ) ) ) {
251 # If there's an exact or very near match, jump right there.
252 $title = $this->getSearchEngine()
253 ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
254 if ( is_null( $title ) ) {
258 if ( !Hooks
::run( 'SpecialSearchGoResult', [ $term, $title, &$url ] ) ) {
262 return $url === null ?
$title->getFullUrlForRedirect() : $url;
266 * @param string $term
268 public function showResults( $term ) {
271 if ( $this->searchEngineType
!== null ) {
272 $this->setExtraParam( 'srbackend', $this->searchEngineType
);
275 $out = $this->getOutput();
276 $formWidget = new MediaWiki\Widget\Search\
SearchFormWidget(
279 $this->getSearchProfiles()
281 $filePrefix = $wgContLang->getFormattedNsText( NS_FILE
) . ':';
282 if ( trim( $term ) === '' ||
$filePrefix === trim( $term ) ) {
283 // Empty query -- straight view of search form
284 if ( !Hooks
::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
285 # Hook requested termination
289 // The form also contains the 'Showing results 0 - 20 of 1234' so we can
290 // only do the form render here for the empty $term case. Rendering
291 // the form when a search is provided is repeated below.
292 $out->addHTML( $formWidget->render(
293 $this->profile
, $term, 0, 0, $this->offset
, $this->isPowerSearch()
298 $search = $this->getSearchEngine();
299 $search->setFeatureData( 'rewrite', $this->runSuggestion
);
300 $search->setLimitOffset( $this->limit
, $this->offset
);
301 $search->setNamespaces( $this->namespaces
);
302 $search->prefix
= $this->mPrefix
;
303 $term = $search->transformSearchTerm( $term );
305 Hooks
::run( 'SpecialSearchSetupEngine', [ $this, $this->profile
, $search ] );
306 if ( !Hooks
::run( 'SpecialSearchResultsPrepend', [ $this, $out, $term ] ) ) {
307 # Hook requested termination
311 $title = Title
::newFromText( $term );
312 $showSuggestion = $title === null ||
!$title->isKnown();
313 $search->setShowSuggestion( $showSuggestion );
315 // fetch search results
316 $rewritten = $search->replacePrefixes( $term );
318 $titleMatches = $search->searchTitle( $rewritten );
319 $textMatches = $search->searchText( $rewritten );
322 if ( $textMatches instanceof Status
) {
323 $textStatus = $textMatches;
324 $textMatches = $textStatus->getValue();
327 // Get number of results
328 $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
329 if ( $titleMatches ) {
330 $titleMatchesNum = $titleMatches->numRows();
331 $numTitleMatches = $titleMatches->getTotalHits();
333 if ( $textMatches ) {
334 $textMatchesNum = $textMatches->numRows();
335 $numTextMatches = $textMatches->getTotalHits();
336 if ( $textMatchesNum > 0 ) {
337 $search->augmentSearchResults( $textMatches );
340 $num = $titleMatchesNum +
$textMatchesNum;
341 $totalRes = $numTitleMatches +
$numTextMatches;
343 // start rendering the page
345 $out->addHTML( $formWidget->render(
346 $this->profile
, $term, $num, $totalRes, $this->offset
, $this->isPowerSearch()
349 // did you mean... suggestions
350 if ( $textMatches ) {
351 $dymWidget = new MediaWiki\Widget\Search\
DidYouMeanWidget( $this );
352 $out->addHTML( $dymWidget->render( $term, $textMatches ) );
355 $hasErrors = $textStatus && $textStatus->getErrors() !== [];
356 $hasOtherResults = $textMatches &&
357 $textMatches->hasInterwikiResults( SearchResultSet
::INLINE_RESULTS
);
359 if ( $textMatches && $textMatches->hasInterwikiResults( SearchResultSet
::SECONDARY_RESULTS
) ) {
360 $out->addHTML( '<div class="searchresults mw-searchresults-has-iw">' );
362 $out->addHTML( '<div class="searchresults">' );
366 list( $error, $warning ) = $textStatus->splitByErrorType();
367 if ( $error->getErrors() ) {
368 $out->addHTML( Html
::errorBox(
369 $error->getHTML( 'search-error' )
372 if ( $warning->getErrors() ) {
373 $out->addHTML( Html
::warningBox(
374 $warning->getHTML( 'search-warning' )
379 // Show the create link ahead
380 $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
382 Hooks
::run( 'SpecialSearchResults', [ $term, &$titleMatches, &$textMatches ] );
384 // If we have no results and have not already displayed an error message
385 if ( $num === 0 && !$hasErrors ) {
386 $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
387 $hasOtherResults ?
'search-nonefound-thiswiki' : 'search-nonefound',
388 wfEscapeWikiText( $term )
392 // Although $num might be 0 there can still be secondary or inline
393 // results to display.
394 $linkRenderer = $this->getLinkRenderer();
395 $mainResultWidget = new FullSearchResultWidget( $this, $linkRenderer );
397 // Default (null) on. Can be explicitly disabled.
398 if ( $search->getFeatureData( 'enable-new-crossproject-page' ) !== false ) {
399 $sidebarResultWidget = new InterwikiSearchResultWidget( $this, $linkRenderer );
400 $sidebarResultsWidget = new InterwikiSearchResultSetWidget(
402 $sidebarResultWidget,
404 MediaWikiServices
::getInstance()->getInterwikiLookup(),
405 $search->getFeatureData( 'show-multimedia-search-results' )
408 $sidebarResultWidget = new SimpleSearchResultWidget( $this, $linkRenderer );
409 $sidebarResultsWidget = new SimpleSearchResultSetWidget(
411 $sidebarResultWidget,
413 MediaWikiServices
::getInstance()->getInterwikiLookup()
417 $widget = new BasicSearchResultSetWidget( $this, $mainResultWidget, $sidebarResultsWidget );
419 $out->addHTML( $widget->render(
420 $term, $this->offset
, $titleMatches, $textMatches
423 if ( $titleMatches ) {
424 $titleMatches->free();
427 if ( $textMatches ) {
428 $textMatches->free();
431 $out->addHTML( '<div class="mw-search-visualclear"></div>' );
434 if ( $totalRes > $this->limit ||
$this->offset
) {
435 // Allow matches to define the correct offset, as interleaved
436 // AB testing may require a different next page offset.
437 if ( $textMatches && $textMatches->getOffset() !== null ) {
438 $offset = $textMatches->getOffset();
440 $offset = $this->offset
;
443 $prevnext = $this->getLanguage()->viewPrevNext(
444 $this->getPageTitle(),
447 $this->powerSearchOptions() +
[ 'search' => $term ],
448 $this->limit +
$this->offset
>= $totalRes
450 $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevnext}</p>\n" );
453 // Close <div class='searchresults'>
454 $out->addHTML( "</div>" );
456 Hooks
::run( 'SpecialSearchResultsAppend', [ $this, $out, $term ] );
460 * @param Title $title
461 * @param int $num The number of search results found
462 * @param null|SearchResultSet $titleMatches Results from title search
463 * @param null|SearchResultSet $textMatches Results from text search
465 protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
466 // show direct page/create link if applicable
468 // Check DBkey !== '' in case of fragment link only.
469 if ( is_null( $title ) ||
$title->getDBkey() === ''
470 ||
( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
471 ||
( $textMatches !== null && $textMatches->searchContainedSyntax() )
474 // preserve the paragraph for margins etc...
475 $this->getOutput()->addHTML( '<p></p>' );
480 $messageName = 'searchmenu-new-nocreate';
481 $linkClass = 'mw-search-createlink';
483 if ( !$title->isExternal() ) {
484 if ( $title->isKnown() ) {
485 $messageName = 'searchmenu-exists';
486 $linkClass = 'mw-search-exists';
487 } elseif ( ContentHandler
::getForTitle( $title )->supportsDirectEditing()
488 && $title->quickUserCan( 'create', $this->getUser() )
490 $messageName = 'searchmenu-new';
496 wfEscapeWikiText( $title->getPrefixedText() ),
497 Message
::numParam( $num )
499 Hooks
::run( 'SpecialSearchCreateLink', [ $title, &$params ] );
501 // Extensions using the hook might still return an empty $messageName
502 if ( $messageName ) {
503 $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
505 // preserve the paragraph for margins etc...
506 $this->getOutput()->addHTML( '<p></p>' );
511 * Sets up everything for the HTML output page including styles, javascript,
514 * @param string $term
516 protected function setupPage( $term ) {
517 $out = $this->getOutput();
520 $this->outputHeader();
521 // TODO: Is this true? The namespace remember uses a user token
523 $out->allowClickjacking();
524 $this->addHelpLink( 'Help:Searching' );
526 if ( strval( $term ) !== '' ) {
527 $out->setPageTitle( $this->msg( 'searchresults' ) );
528 $out->setHTMLTitle( $this->msg( 'pagetitle' )
529 ->plaintextParams( $this->msg( 'searchresults-title' )->plaintextParams( $term )->text() )
530 ->inContentLanguage()->text()
534 $out->addJsConfigVars( [ 'searchTerm' => $term ] );
535 $out->addModules( 'mediawiki.special.search' );
536 $out->addModuleStyles( [
537 'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
538 'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
543 * Return true if current search is a power (advanced) search
547 protected function isPowerSearch() {
548 return $this->profile
=== 'advanced';
552 * Extract "power search" namespace settings from the request object,
553 * returning a list of index numbers to search.
555 * @param WebRequest &$request
558 protected function powerSearch( &$request ) {
560 foreach ( $this->searchConfig
->searchableNamespaces() as $ns => $name ) {
561 if ( $request->getCheck( 'ns' . $ns ) ) {
570 * Reconstruct the 'power search' options for links
571 * TODO: Instead of exposing this publicly, could we instead expose
572 * a function for creating search links?
576 public function powerSearchOptions() {
578 if ( $this->isPowerSearch() ) {
579 foreach ( $this->namespaces
as $n ) {
583 $opt['profile'] = $this->profile
;
586 return $opt +
$this->extraParams
;
590 * Save namespace preferences when we're supposed to
592 * @return bool Whether we wrote something
594 protected function saveNamespaces() {
595 $user = $this->getUser();
596 $request = $this->getRequest();
598 if ( $user->isLoggedIn() &&
599 $user->matchEditToken(
600 $request->getVal( 'nsRemember' ),
605 // Reset namespace preferences: namespaces are not searched
606 // when they're not mentioned in the URL parameters.
607 foreach ( MWNamespace
::getValidNamespaces() as $n ) {
608 $user->setOption( 'searchNs' . $n, false );
610 // The request parameters include all the namespaces to be searched.
611 // Even if they're the same as an existing profile, they're not eaten.
612 foreach ( $this->namespaces
as $n ) {
613 $user->setOption( 'searchNs' . $n, true );
616 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
617 $user->saveSettings();
629 protected function getSearchProfiles() {
630 // Builds list of Search Types (profiles)
631 $nsAllSet = array_keys( $this->searchConfig
->searchableNamespaces() );
632 $defaultNs = $this->searchConfig
->defaultNamespaces();
635 'message' => 'searchprofile-articles',
636 'tooltip' => 'searchprofile-articles-tooltip',
637 'namespaces' => $defaultNs,
638 'namespace-messages' => $this->searchConfig
->namespacesAsText(
643 'message' => 'searchprofile-images',
644 'tooltip' => 'searchprofile-images-tooltip',
645 'namespaces' => [ NS_FILE
],
648 'message' => 'searchprofile-everything',
649 'tooltip' => 'searchprofile-everything-tooltip',
650 'namespaces' => $nsAllSet,
653 'message' => 'searchprofile-advanced',
654 'tooltip' => 'searchprofile-advanced-tooltip',
655 'namespaces' => self
::NAMESPACES_CURRENT
,
659 Hooks
::run( 'SpecialSearchProfiles', [ &$profiles ] );
661 foreach ( $profiles as &$data ) {
662 if ( !is_array( $data['namespaces'] ) ) {
665 sort( $data['namespaces'] );
674 * @return SearchEngine
676 public function getSearchEngine() {
677 if ( $this->searchEngine
=== null ) {
678 $this->searchEngine
= $this->searchEngineType ?
679 MediaWikiServices
::getInstance()->getSearchEngineFactory()->create( $this->searchEngineType
) :
680 MediaWikiServices
::getInstance()->newSearchEngine();
683 return $this->searchEngine
;
687 * Current search profile.
688 * @return null|string
690 function getProfile() {
691 return $this->profile
;
695 * Current namespaces.
698 function getNamespaces() {
699 return $this->namespaces
;
703 * Users of hook SpecialSearchSetupEngine can use this to
704 * add more params to links to not lose selection when
705 * user navigates search results.
709 * @param mixed $value
711 public function setExtraParam( $key, $value ) {
712 $this->extraParams
[$key] = $value;
715 protected function getGroupName() {