MediaWiki  master
SpecialSearch.php
Go to the documentation of this file.
1 <?php
33 
38 class SpecialSearch extends SpecialPage {
47  protected $profile;
48 
50  protected $searchEngine;
51 
53  protected $searchEngineType;
54 
56  protected $extraParams = [];
57 
62  protected $mPrefix;
63 
67  protected $limit, $offset;
68 
72  protected $namespaces;
73 
77  protected $fulltext;
78 
83 
87  protected $runSuggestion = true;
88 
93  protected $searchConfig;
94 
99  private $loadStatus;
100 
101  private const NAMESPACES_CURRENT = 'sense';
102 
103  public function __construct() {
104  parent::__construct( 'Search' );
105  $this->searchConfig = MediaWikiServices::getInstance()->getSearchEngineConfig();
106  }
107 
113  public function execute( $par ) {
114  $request = $this->getRequest();
115  $out = $this->getOutput();
116 
117  // Fetch the search term
118  $term = str_replace( "\n", " ", $request->getText( 'search' ) );
119 
120  // Historically search terms have been accepted not only in the search query
121  // parameter, but also as part of the primary url. This can have PII implications
122  // in releasing page view data. As such issue a 301 redirect to the correct
123  // URL.
124  if ( $par !== null && $par !== '' && $term === '' ) {
125  $query = $request->getValues();
126  unset( $query['title'] );
127  // Strip underscores from title parameter; most of the time we'll want
128  // text form here. But don't strip underscores from actual text params!
129  $query['search'] = str_replace( '_', ' ', $par );
130  $out->redirect( $this->getPageTitle()->getFullURL( $query ), 301 );
131  return;
132  }
133 
134  // Need to load selected namespaces before handling nsRemember
135  $this->load();
136  // TODO: This performs database actions on GET request, which is going to
137  // be a problem for our multi-datacenter work.
138  if ( $request->getCheck( 'nsRemember' ) ) {
139  $this->saveNamespaces();
140  // Remove the token from the URL to prevent the user from inadvertently
141  // exposing it (e.g. by pasting it into a public wiki page) or undoing
142  // later settings changes (e.g. by reloading the page).
143  $query = $request->getValues();
144  unset( $query['title'], $query['nsRemember'] );
145  $out->redirect( $this->getPageTitle()->getFullURL( $query ) );
146  return;
147  }
148 
149  $this->searchEngineType = $request->getVal( 'srbackend' );
150  if ( !$request->getVal( 'fulltext' ) && !$request->getCheck( 'offset' ) ) {
151  $url = $this->goResult( $term );
152  if ( $url !== null ) {
153  // successful 'go'
154  $out->redirect( $url );
155  return;
156  }
157  // No match. If it could plausibly be a title
158  // run the No go match hook.
159  $title = Title::newFromText( $term );
160  if ( $title !== null ) {
161  $this->getHookRunner()->onSpecialSearchNogomatch( $title );
162  }
163  }
164 
165  $this->setupPage( $term );
166 
167  if ( $this->getConfig()->get( 'DisableTextSearch' ) ) {
168  $searchForwardUrl = $this->getConfig()->get( 'SearchForwardUrl' );
169  if ( $searchForwardUrl ) {
170  $url = str_replace( '$1', urlencode( $term ), $searchForwardUrl );
171  $out->redirect( $url );
172  } else {
173  $this->showGoogleSearch( $term );
174  }
175 
176  return;
177  }
178 
179  $this->showResults( $term );
180  }
181 
189  private function showGoogleSearch( $term ) {
190  $this->getOutput()->addHTML(
191  "<fieldset>" .
192  "<legend>" .
193  $this->msg( 'search-external' )->escaped() .
194  "</legend>" .
195  "<p class='mw-searchdisabled'>" .
196  $this->msg( 'searchdisabled' )->escaped() .
197  "</p>" .
198  $this->msg( 'googlesearch' )->rawParams(
199  htmlspecialchars( $term ),
200  'UTF-8',
201  $this->msg( 'searchbutton' )->escaped()
202  )->text() .
203  "</fieldset>"
204  );
205  }
206 
212  public function load() {
213  $this->loadStatus = new Status();
214 
215  $request = $this->getRequest();
216  list( $this->limit, $this->offset ) = $request->getLimitOffsetForUser(
217  $this->getUser(),
218  20,
219  ''
220  );
221  $this->mPrefix = $request->getVal( 'prefix', '' );
222  if ( $this->mPrefix !== '' ) {
223  $this->setExtraParam( 'prefix', $this->mPrefix );
224  }
225 
226  $sort = $request->getVal( 'sort', SearchEngine::DEFAULT_SORT );
227  $validSorts = $this->getSearchEngine()->getValidSorts();
228  if ( !in_array( $sort, $validSorts ) ) {
229  $this->loadStatus->warning( 'search-invalid-sort-order', $sort,
230  implode( ', ', $validSorts ) );
231  } elseif ( $sort !== $this->sort ) {
232  $this->sort = $sort;
233  $this->setExtraParam( 'sort', $this->sort );
234  }
235 
236  $user = $this->getUser();
237 
238  # Extract manually requested namespaces
239  $nslist = $this->powerSearch( $request );
240  if ( $nslist === [] ) {
241  # Fallback to user preference
242  $nslist = $this->searchConfig->userNamespaces( $user );
243  }
244 
245  $profile = null;
246  if ( $nslist === [] ) {
247  $profile = 'default';
248  }
249 
250  $profile = $request->getVal( 'profile', $profile );
251  $profiles = $this->getSearchProfiles();
252  if ( $profile === null ) {
253  // BC with old request format
254  $profile = 'advanced';
255  foreach ( $profiles as $key => $data ) {
256  if ( $nslist === $data['namespaces'] && $key !== 'advanced' ) {
257  $profile = $key;
258  }
259  }
260  $this->namespaces = $nslist;
261  } elseif ( $profile === 'advanced' ) {
262  $this->namespaces = $nslist;
263  } elseif ( isset( $profiles[$profile]['namespaces'] ) ) {
264  $this->namespaces = $profiles[$profile]['namespaces'];
265  } else {
266  // Unknown profile requested
267  $this->loadStatus->warning( 'search-unknown-profile', $profile );
268  $profile = 'default';
269  $this->namespaces = $profiles['default']['namespaces'];
270  }
271 
272  $this->fulltext = $request->getVal( 'fulltext' );
273  $this->runSuggestion = (bool)$request->getVal( 'runsuggestion', true );
274  $this->profile = $profile;
275  }
276 
283  public function goResult( $term ) {
284  # If the string cannot be used to create a title
285  if ( Title::newFromText( $term ) === null ) {
286  return null;
287  }
288  # If there's an exact or very near match, jump right there.
289  $title = $this->getSearchEngine()
290  ->getNearMatcher( $this->getConfig() )->getNearMatch( $term );
291  if ( $title === null ) {
292  return null;
293  }
294  $url = null;
295  if ( !$this->getHookRunner()->onSpecialSearchGoResult( $term, $title, $url ) ) {
296  return null;
297  }
298 
299  if (
300  // If there is a preference set to NOT redirect on exact page match
301  // then return null (which prevents direction)
302  !$this->redirectOnExactMatch()
303  // BUT ...
304  // ... ignore no-redirect preference if the exact page match is an interwiki link
305  && !$title->isExternal()
306  // ... ignore no-redirect preference if the exact page match is NOT in the main
307  // namespace AND there's a namespace in the search string
308  && !( $title->getNamespace() !== NS_MAIN && strpos( $term, ':' ) > 0 )
309  ) {
310  return null;
311  }
312 
313  return $url ?? $title->getFullUrlForRedirect();
314  }
315 
316  private function redirectOnExactMatch() {
319  // If the preference for whether to redirect is disabled, use the default setting
320  $defaultOptions = $this->getUser()->getDefaultOptions();
321  return $defaultOptions['search-match-redirect'];
322  } else {
323  // Otherwise use the user's preference
324  return $this->getUser()->getOption( 'search-match-redirect' );
325  }
326  }
327 
331  public function showResults( $term ) {
332  if ( $this->searchEngineType !== null ) {
333  $this->setExtraParam( 'srbackend', $this->searchEngineType );
334  }
335 
336  $out = $this->getOutput();
337  $widgetOptions = $this->getConfig()->get( 'SpecialSearchFormOptions' );
339  $this,
340  $this->searchConfig,
341  $this->getHookContainer(),
342  $this->getSearchProfiles()
343  );
344  $filePrefix = MediaWikiServices::getInstance()->getContentLanguage()->
345  getFormattedNsText( NS_FILE ) . ':';
346  if ( trim( $term ) === '' || $filePrefix === trim( $term ) ) {
347  // Empty query -- straight view of search form
348  if ( !$this->getHookRunner()->onSpecialSearchResultsPrepend( $this, $out, $term ) ) {
349  # Hook requested termination
350  return;
351  }
352  $out->enableOOUI();
353  // The form also contains the 'Showing results 0 - 20 of 1234' so we can
354  // only do the form render here for the empty $term case. Rendering
355  // the form when a search is provided is repeated below.
356  $out->addHTML( $formWidget->render(
357  $this->profile, $term, 0, 0, $this->offset, $this->isPowerSearch(), $widgetOptions
358  ) );
359  return;
360  }
361 
362  $engine = $this->getSearchEngine();
363  $engine->setFeatureData( 'rewrite', $this->runSuggestion );
364  $engine->setLimitOffset( $this->limit, $this->offset );
365  $engine->setNamespaces( $this->namespaces );
366  $engine->setSort( $this->sort );
367  $engine->prefix = $this->mPrefix;
368 
369  $this->getHookRunner()->onSpecialSearchSetupEngine( $this, $this->profile, $engine );
370  if ( !$this->getHookRunner()->onSpecialSearchResultsPrepend( $this, $out, $term ) ) {
371  # Hook requested termination
372  return;
373  }
374 
375  $title = Title::newFromText( $term );
376  $showSuggestion = $title === null || !$title->isKnown();
377  $engine->setShowSuggestion( $showSuggestion );
378 
379  $rewritten = $engine->replacePrefixes( $term );
380  if ( $rewritten !== $term ) {
381  wfDeprecated( 'SearchEngine::replacePrefixes() (overridden by ' .
382  get_class( $engine ) . ')', '1.32' );
383  }
384 
385  // fetch search results
386  $titleMatches = $engine->searchTitle( $rewritten );
387  $textMatches = $engine->searchText( $rewritten );
388 
389  $textStatus = null;
390  if ( $textMatches instanceof Status ) {
391  $textStatus = $textMatches;
392  $textMatches = $textStatus->getValue();
393  }
394 
395  // Get number of results
396  $titleMatchesNum = $textMatchesNum = $numTitleMatches = $numTextMatches = 0;
397  if ( $titleMatches ) {
398  $titleMatchesNum = $titleMatches->numRows();
399  $numTitleMatches = $titleMatches->getTotalHits();
400  }
401  if ( $textMatches ) {
402  $textMatchesNum = $textMatches->numRows();
403  $numTextMatches = $textMatches->getTotalHits();
404  if ( $textMatchesNum > 0 ) {
405  $engine->augmentSearchResults( $textMatches );
406  }
407  }
408  $num = $titleMatchesNum + $textMatchesNum;
409  $totalRes = $numTitleMatches + $numTextMatches;
410 
411  // start rendering the page
412  $out->enableOOUI();
413  $out->addHTML( $formWidget->render(
414  $this->profile, $term, $num, $totalRes, $this->offset, $this->isPowerSearch(), $widgetOptions
415  ) );
416 
417  // did you mean... suggestions
418  if ( $textMatches ) {
419  $dymWidget = new MediaWiki\Search\SearchWidgets\DidYouMeanWidget( $this );
420  $out->addHTML( $dymWidget->render( $term, $textMatches ) );
421  }
422 
423  $hasSearchErrors = $textStatus && $textStatus->getErrors() !== [];
424  $hasOtherResults = $textMatches &&
425  $textMatches->hasInterwikiResults( ISearchResultSet::INLINE_RESULTS );
426 
427  if ( $textMatches && $textMatches->hasInterwikiResults( ISearchResultSet::SECONDARY_RESULTS ) ) {
428  $out->addHTML( '<div class="searchresults mw-searchresults-has-iw">' );
429  } else {
430  $out->addHTML( '<div class="searchresults">' );
431  }
432 
433  if ( $hasSearchErrors || $this->loadStatus->getErrors() ) {
434  if ( $textStatus === null ) {
435  $textStatus = $this->loadStatus;
436  } else {
437  $textStatus->merge( $this->loadStatus );
438  }
439  list( $error, $warning ) = $textStatus->splitByErrorType();
440  if ( $error->getErrors() ) {
441  $out->addHTML( Html::errorBox(
442  $error->getHTML( 'search-error' )
443  ) );
444  }
445  if ( $warning->getErrors() ) {
446  $out->addHTML( Html::warningBox(
447  $warning->getHTML( 'search-warning' )
448  ) );
449  }
450  }
451 
452  // Show the create link ahead
453  $this->showCreateLink( $title, $num, $titleMatches, $textMatches );
454 
455  $this->getHookRunner()->onSpecialSearchResults( $term, $titleMatches, $textMatches );
456 
457  // If we have no results and have not already displayed an error message
458  if ( $num === 0 && !$hasSearchErrors ) {
459  $out->wrapWikiMsg( "<p class=\"mw-search-nonefound\">\n$1</p>", [
460  $hasOtherResults ? 'search-nonefound-thiswiki' : 'search-nonefound',
461  wfEscapeWikiText( $term )
462  ] );
463  }
464 
465  // Although $num might be 0 there can still be secondary or inline
466  // results to display.
467  $linkRenderer = $this->getLinkRenderer();
468  $mainResultWidget = new FullSearchResultWidget(
469  $this, $linkRenderer, $this->getHookContainer() );
470 
471  // Default (null) on. Can be explicitly disabled.
472  if ( $engine->getFeatureData( 'enable-new-crossproject-page' ) !== false ) {
473  $sidebarResultWidget = new InterwikiSearchResultWidget( $this, $linkRenderer );
474  $sidebarResultsWidget = new InterwikiSearchResultSetWidget(
475  $this,
476  $sidebarResultWidget,
478  MediaWikiServices::getInstance()->getInterwikiLookup(),
479  $engine->getFeatureData( 'show-multimedia-search-results' )
480  );
481  } else {
482  $sidebarResultWidget = new SimpleSearchResultWidget( $this, $linkRenderer );
483  $sidebarResultsWidget = new SimpleSearchResultSetWidget(
484  $this,
485  $sidebarResultWidget,
487  MediaWikiServices::getInstance()->getInterwikiLookup()
488  );
489  }
490 
491  $widget = new BasicSearchResultSetWidget( $this, $mainResultWidget, $sidebarResultsWidget );
492 
493  $out->addHTML( $widget->render(
494  $term, $this->offset, $titleMatches, $textMatches
495  ) );
496 
497  $out->addHTML( '<div class="mw-search-visualclear"></div>' );
498 
499  // prev/next links
500  if ( $totalRes > $this->limit || $this->offset ) {
501  // Allow matches to define the correct offset, as interleaved
502  // AB testing may require a different next page offset.
503  if ( $textMatches && $textMatches->getOffset() !== null ) {
504  $offset = $textMatches->getOffset();
505  } else {
507  }
508 
509  $prevNext = $this->buildPrevNextNavigation(
510  $offset,
511  $this->limit,
512  $this->powerSearchOptions() + [ 'search' => $term ],
513  $this->limit + $this->offset >= $totalRes
514  );
515  $out->addHTML( "<p class='mw-search-pager-bottom'>{$prevNext}</p>\n" );
516  }
517 
518  // Close <div class='searchresults'>
519  $out->addHTML( "</div>" );
520 
521  $this->getHookRunner()->onSpecialSearchResultsAppend( $this, $out, $term );
522  }
523 
530  protected function showCreateLink( $title, $num, $titleMatches, $textMatches ) {
531  // show direct page/create link if applicable
532 
533  // Check DBkey !== '' in case of fragment link only.
534  if ( $title === null || $title->getDBkey() === ''
535  || ( $titleMatches !== null && $titleMatches->searchContainedSyntax() )
536  || ( $textMatches !== null && $textMatches->searchContainedSyntax() )
537  ) {
538  // invalid title
539  // preserve the paragraph for margins etc...
540  $this->getOutput()->addHTML( '<p></p>' );
541 
542  return;
543  }
544 
545  $messageName = 'searchmenu-new-nocreate';
546  $linkClass = 'mw-search-createlink';
547 
548  if ( !$title->isExternal() ) {
549  if ( $title->isKnown() ) {
550  $messageName = 'searchmenu-exists';
551  $linkClass = 'mw-search-exists';
552  } elseif (
553  MediaWikiServices::getInstance()
554  ->getContentHandlerFactory()
555  ->getContentHandler( $title->getContentModel() )
556  ->supportsDirectEditing()
557  && MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan( 'create',
558  $this->getUser(), $title )
559  && MediaWikiServices::getInstance()->getPermissionManager()->quickUserCan( 'edit',
560  $this->getUser(), $title )
561  ) {
562  $messageName = 'searchmenu-new';
563  }
564  }
565 
566  $params = [
567  $messageName,
568  wfEscapeWikiText( $title->getPrefixedText() ),
569  Message::numParam( $num )
570  ];
571  $this->getHookRunner()->onSpecialSearchCreateLink( $title, $params );
572 
573  // Extensions using the hook might still return an empty $messageName
574  if ( $messageName ) {
575  $this->getOutput()->wrapWikiMsg( "<p class=\"$linkClass\">\n$1</p>", $params );
576  } else {
577  // preserve the paragraph for margins etc...
578  $this->getOutput()->addHTML( '<p></p>' );
579  }
580  }
581 
588  protected function setupPage( $term ) {
589  $out = $this->getOutput();
590 
591  $this->setHeaders();
592  $this->outputHeader();
593  // TODO: Is this true? The namespace remember uses a user token
594  // on save.
595  $out->allowClickjacking();
596  $this->addHelpLink( 'Help:Searching' );
597 
598  if ( strval( $term ) !== '' ) {
599  $out->setPageTitle( $this->msg( 'searchresults' ) );
600  $out->setHTMLTitle( $this->msg( 'pagetitle' )
601  ->plaintextParams( $this->msg( 'searchresults-title' )->plaintextParams( $term )->text() )
602  ->inContentLanguage()->text()
603  );
604  }
605 
606  if ( $this->mPrefix !== '' ) {
607  $subtitle = $this->msg( 'search-filter-title-prefix' )->plaintextParams( $this->mPrefix );
608  $params = $this->powerSearchOptions();
609  unset( $params['prefix'] );
610  $params += [
611  'search' => $term,
612  'fulltext' => 1,
613  ];
614 
615  $subtitle .= ' (';
616  $subtitle .= Xml::element(
617  'a',
618  [
619  'href' => $this->getPageTitle()->getLocalURL( $params ),
620  'title' => $this->msg( 'search-filter-title-prefix-reset' )->text(),
621  ],
622  $this->msg( 'search-filter-title-prefix-reset' )->text()
623  );
624  $subtitle .= ')';
625  $out->setSubtitle( $subtitle );
626  }
627 
628  $out->addJsConfigVars( [ 'searchTerm' => $term ] );
629  $out->addModules( 'mediawiki.special.search' );
630  $out->addModuleStyles( [
631  'mediawiki.special', 'mediawiki.special.search.styles', 'mediawiki.ui', 'mediawiki.ui.button',
632  'mediawiki.ui.input', 'mediawiki.widgets.SearchInputWidget.styles',
633  ] );
634  }
635 
641  protected function isPowerSearch() {
642  return $this->profile === 'advanced';
643  }
644 
652  protected function powerSearch( &$request ) {
653  $arr = [];
654  foreach ( $this->searchConfig->searchableNamespaces() as $ns => $name ) {
655  if ( $request->getCheck( 'ns' . $ns ) ) {
656  $arr[] = $ns;
657  }
658  }
659 
660  return $arr;
661  }
662 
670  public function powerSearchOptions() {
671  $opt = [];
672  if ( $this->isPowerSearch() ) {
673  foreach ( $this->namespaces as $n ) {
674  $opt['ns' . $n] = 1;
675  }
676  } else {
677  $opt['profile'] = $this->profile;
678  }
679 
680  return $opt + $this->extraParams;
681  }
682 
688  protected function saveNamespaces() {
689  $user = $this->getUser();
690  $request = $this->getRequest();
691 
692  if ( $user->isLoggedIn() &&
693  $user->matchEditToken(
694  $request->getVal( 'nsRemember' ),
695  'searchnamespace',
696  $request
697  ) && !wfReadOnly()
698  ) {
699  // Reset namespace preferences: namespaces are not searched
700  // when they're not mentioned in the URL parameters.
701  foreach ( MediaWikiServices::getInstance()->getNamespaceInfo()->getValidNamespaces()
702  as $n
703  ) {
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 
726  protected function getSearchProfiles() {
727  // Builds list of Search Types (profiles)
728  $nsAllSet = array_keys( $this->searchConfig->searchableNamespaces() );
729  $defaultNs = $this->searchConfig->defaultNamespaces();
730  $profiles = [
731  'default' => [
732  'message' => 'searchprofile-articles',
733  'tooltip' => 'searchprofile-articles-tooltip',
734  'namespaces' => $defaultNs,
735  'namespace-messages' => $this->searchConfig->namespacesAsText(
736  $defaultNs
737  ),
738  ],
739  'images' => [
740  'message' => 'searchprofile-images',
741  'tooltip' => 'searchprofile-images-tooltip',
742  'namespaces' => [ NS_FILE ],
743  ],
744  'all' => [
745  'message' => 'searchprofile-everything',
746  'tooltip' => 'searchprofile-everything-tooltip',
747  'namespaces' => $nsAllSet,
748  ],
749  'advanced' => [
750  'message' => 'searchprofile-advanced',
751  'tooltip' => 'searchprofile-advanced-tooltip',
752  'namespaces' => self::NAMESPACES_CURRENT,
753  ]
754  ];
755 
756  $this->getHookRunner()->onSpecialSearchProfiles( $profiles );
757 
758  foreach ( $profiles as &$data ) {
759  if ( !is_array( $data['namespaces'] ) ) {
760  continue;
761  }
762  sort( $data['namespaces'] );
763  }
764 
765  return $profiles;
766  }
767 
773  public function getSearchEngine() {
774  if ( $this->searchEngine === null ) {
775  $services = MediaWikiServices::getInstance();
776  $this->searchEngine = $this->searchEngineType ?
777  $services->getSearchEngineFactory()->create( $this->searchEngineType ) :
778  $services->newSearchEngine();
779  }
780 
781  return $this->searchEngine;
782  }
783 
788  public function getProfile() {
789  return $this->profile;
790  }
791 
796  public function getNamespaces() {
797  return $this->namespaces;
798  }
799 
809  public function setExtraParam( $key, $value ) {
810  $this->extraParams[$key] = $value;
811  }
812 
821  public function getPrefix() {
822  return $this->mPrefix;
823  }
824 
825  protected function getGroupName() {
826  return 'pages';
827  }
828 }
MediaWiki\Search\SearchWidgets\DidYouMeanWidget
Renders a suggested search for the user, or tells the user a suggested search was run instead of the ...
Definition: DidYouMeanWidget.php:12
SpecialSearch\getNamespaces
getNamespaces()
Current namespaces.
Definition: SpecialSearch.php:796
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:669
Message\numParam
static numParam( $num)
Definition: Message.php:1046
SpecialPage\msg
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:800
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:332
MediaWiki\Search\SearchWidgets\SearchFormWidget
Definition: SearchFormWidget.php:14
SpecialSearch\$fulltext
string $fulltext
Definition: SpecialSearch.php:77
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:716
SpecialSearch\$sort
string $sort
Definition: SpecialSearch.php:82
MediaWiki\Search\SearchWidgets\InterwikiSearchResultSetWidget
Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix.
Definition: InterwikiSearchResultSetWidget.php:18
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:146
SpecialSearch\$limit
int $limit
Definition: SpecialSearch.php:67
MediaWiki\Search\SearchWidgets\InterwikiSearchResultWidget
Renders an enhanced interwiki result.
Definition: InterwikiSearchResultWidget.php:14
NS_FILE
const NS_FILE
Definition: Defines.php:75
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1104
SpecialSearch\$loadStatus
Status $loadStatus
Holds any parameter validation errors that should be displayed back to the user.
Definition: SpecialSearch.php:99
SpecialPage\getHookContainer
getHookContainer()
Definition: SpecialPage.php:961
Html\warningBox
static warningBox( $html, $className='')
Return a warning box.
Definition: Html.php:726
SpecialSearch\getPrefix
getPrefix()
The prefix value send to Special:Search using the 'prefix' URI param It means that the user is willin...
Definition: SpecialSearch.php:821
SpecialSearch\isPowerSearch
isPowerSearch()
Return true if current search is a power (advanced) search.
Definition: SpecialSearch.php:641
SpecialSearch\setupPage
setupPage( $term)
Sets up everything for the HTML output page including styles, javascript, page title,...
Definition: SpecialSearch.php:588
SpecialSearch\getSearchProfiles
getSearchProfiles()
Definition: SpecialSearch.php:726
SearchEngine\DEFAULT_SORT
const DEFAULT_SORT
Definition: SearchEngine.php:37
SpecialSearch\NAMESPACES_CURRENT
const NAMESPACES_CURRENT
Definition: SpecialSearch.php:101
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:42
NS_MAIN
const NS_MAIN
Definition: Defines.php:69
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:836
SpecialPage\getHookRunner
getHookRunner()
Definition: SpecialPage.php:974
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:766
SpecialSearch\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialSearch.php:825
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that $function is deprecated.
Definition: GlobalFunctions.php:1030
SpecialSearch\$searchEngineType
string $searchEngineType
Search engine type, if not default.
Definition: SpecialSearch.php:53
SpecialSearch\$runSuggestion
bool $runSuggestion
Definition: SpecialSearch.php:87
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
StatusValue\merge
merge( $other, $overwriteValue=false)
Merge another status object into this one.
Definition: StatusValue.php:223
MediaWiki\Search\SearchWidgets\BasicSearchResultSetWidget
Renders the search result area.
Definition: BasicSearchResultSetWidget.php:15
$title
$title
Definition: testCompression.php:38
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:551
SpecialSearch\$offset
int $offset
Definition: SpecialSearch.php:67
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:726
SpecialSearch\saveNamespaces
saveNamespaces()
Save namespace preferences when we're supposed to.
Definition: SpecialSearch.php:688
SpecialSearch\__construct
__construct()
Definition: SpecialSearch.php:103
Html\errorBox
static errorBox( $html, $heading='', $className='')
Return an error box.
Definition: Html.php:739
SpecialSearch\$searchConfig
SearchEngineConfig $searchConfig
Search engine configurations.
Definition: SpecialSearch.php:93
ISearchResultSet\INLINE_RESULTS
const INLINE_RESULTS
Identifier for interwiki results that can be displayed even if no existing main wiki results exist.
Definition: ISearchResultSet.php:22
SpecialSearch\showGoogleSearch
showGoogleSearch( $term)
Output a google search form if search is disabled.
Definition: SpecialSearch.php:189
SpecialSearch\$searchEngine
SearchEngine $searchEngine
Search engine.
Definition: SpecialSearch.php:50
SpecialSearch\execute
execute( $par)
Entry point.
Definition: SpecialSearch.php:113
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:39
SpecialPage\buildPrevNextNavigation
buildPrevNextNavigation( $offset, $limit, array $query=[], $atend=false, $subpage=false)
Generate (prev x| next x) (20|50|100...) type links for paging.
Definition: SpecialPage.php:938
SpecialSearch
implements Special:Search - Run text & title search and display the output
Definition: SpecialSearch.php:38
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:706
SpecialSearch\$profile
null string $profile
Current search profile.
Definition: SpecialSearch.php:47
SpecialSearch\powerSearch
powerSearch(&$request)
Extract "power search" namespace settings from the request object, returning a list of index numbers ...
Definition: SpecialSearch.php:652
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1485
SpecialSearch\getProfile
getProfile()
Current search profile.
Definition: SpecialSearch.php:788
MediaWiki\Search\SearchWidgets\SimpleSearchResultSetWidget
Renders one or more ISearchResultSets into a sidebar grouped by interwiki prefix.
Definition: SimpleSearchResultSetWidget.php:19
MediaWiki\Search\SearchWidgets\SimpleSearchResultWidget
Renders a simple one-line result.
Definition: SimpleSearchResultWidget.php:15
SearchEngine
Contain a class for special pages.
Definition: SearchEngine.php:36
SpecialSearch\$extraParams
array $extraParams
For links.
Definition: SpecialSearch.php:56
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:912
SpecialSearch\powerSearchOptions
powerSearchOptions()
Reconstruct the 'power search' options for links TODO: Instead of exposing this publicly,...
Definition: SpecialSearch.php:670
SpecialSearch\goResult
goResult( $term)
If an exact title match can be found, jump straight ahead to it.
Definition: SpecialSearch.php:283
SpecialSearch\$namespaces
array $namespaces
Definition: SpecialSearch.php:72
SpecialSearch\getSearchEngine
getSearchEngine()
Definition: SpecialSearch.php:773
SpecialSearch\setExtraParam
setExtraParam( $key, $value)
Users of hook SpecialSearchSetupEngine can use this to add more params to links to not lose selection...
Definition: SpecialSearch.php:809
SpecialSearch\load
load()
Set up basic search parameters from the request and user settings.
Definition: SpecialSearch.php:212
ISearchResultSet\SECONDARY_RESULTS
const SECONDARY_RESULTS
Identifier for interwiki results that are displayed only together with existing main wiki results.
Definition: ISearchResultSet.php:16
SearchEngineConfig
Configuration handling class for SearchEngine.
Definition: SearchEngineConfig.php:12
SpecialSearch\$mPrefix
string $mPrefix
The prefix url parameter.
Definition: SpecialSearch.php:62
SpecialSearch\showCreateLink
showCreateLink( $title, $num, $titleMatches, $textMatches)
Definition: SpecialSearch.php:530
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:69
DeferredUpdates\addCallableUpdate
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:145
SpecialSearch\showResults
showResults( $term)
Definition: SpecialSearch.php:331
$wgSearchMatchRedirectPreference
bool $wgSearchMatchRedirectPreference
Set true to allow logged-in users to set a preference whether or not matches in search results should...
Definition: DefaultSettings.php:9482
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:636
SpecialSearch\redirectOnExactMatch
redirectOnExactMatch()
Definition: SpecialSearch.php:316
MediaWiki\Search\SearchWidgets\FullSearchResultWidget
Renders a 'full' multi-line search result with metadata.
Definition: FullSearchResultWidget.php:22