68 private $hookContainer;
96 return $this->maybePaginate(
function () use ( $term ) {
157 return $this->maybePaginate(
function () use ( $term ) {
183 private function maybePaginate( Closure $fn ) {
189 $resultSetOrStatus = $fn();
196 $resultSet = $resultSetOrStatus;
197 } elseif ( $resultSetOrStatus instanceof
Status &&
200 $resultSet = $resultSetOrStatus->getValue();
203 $resultSet->shrink( $this->limit );
206 return $resultSetOrStatus;
217 switch ( $feature ) {
218 case 'search-update':
220 case 'title-suffix-filter':
233 $this->features[$feature] = $data;
244 return $this->features[$feature] ??
null;
257 return MediaWikiServices::getInstance()->getContentLanguage()->segmentByWord( $string );
267 return MediaWikiServices::getInstance()->getTitleMatcher();
278 return MediaWikiServices::getInstance()->getTitleMatcher();
288 return "A-Za-z_'.0-9\\x80-\\xFF\\-";
299 $this->limit = intval(
$limit );
300 $this->offset = intval(
$offset );
312 $validNs = MediaWikiServices::getInstance()->getSearchEngineConfig()->searchableNamespaces();
314 return $ns < 0 || isset( $validNs[$ns] );
356 throw new InvalidArgumentException(
"Invalid sort: $sort. " .
357 "Must be one of: " . implode(
', ', $this->
getValidSorts() ) );
402 $withAllKeyword =
true,
403 $withPrefixSearchExtractNamespaceHook =
false
406 if ( strpos( $query,
':' ) ===
false ) {
409 $extractedNamespace =
null;
412 if ( $withAllKeyword ) {
415 $allkeywords[] =
wfMessage(
'searchall' )->inContentLanguage()->text() .
":";
417 if ( !in_array(
'all:', $allkeywords ) ) {
418 $allkeywords[] =
'all:';
421 foreach ( $allkeywords as $kw ) {
422 if ( str_starts_with( $query, $kw ) ) {
423 $parsed = substr( $query, strlen( $kw ) );
430 if ( !$allQuery && strpos( $query,
':' ) !==
false ) {
431 $prefix = str_replace(
' ',
'_', substr( $query, 0, strpos( $query,
':' ) ) );
432 $index = MediaWikiServices::getInstance()->getContentLanguage()->getNsIndex(
$prefix );
433 if ( $index !==
false ) {
434 $extractedNamespace = [ $index ];
435 $parsed = substr( $query, strlen(
$prefix ) + 1 );
436 } elseif ( $withPrefixSearchExtractNamespaceHook ) {
439 Hooks::runner()->onPrefixSearchExtractNamespace( $hookNamespaces, $hookQuery );
440 if ( $hookQuery !== $query ) {
441 $parsed = $hookQuery;
442 $extractedNamespace = $hookNamespaces;
451 return [ $parsed, $extractedNamespace ];
464 return [ $contextlines, $contextchars ];
516 return $c ? $c->getTextForSearchIndex() :
'';
539 if ( $queryAndNs !==
false ) {
541 return $queryAndNs[0];
575 $search = trim( $search );
577 if ( !in_array(
NS_SPECIAL, $this->namespaces ) &&
579 $this->namespaces, $search, $this->limit, $results, $this->offset )
598 if ( trim( $search ) ===
'' ) {
614 if ( trim( $search ) ===
'' ) {
620 $fallbackLimit = 1 + $this->limit - $results->getSize();
621 if ( $fallbackLimit > 0 ) {
622 $services = MediaWikiServices::getInstance();
623 $fallbackSearches = $services->getLanguageConverterFactory()
624 ->getLanguageConverter( $services->getContentLanguage() )
625 ->autoConvertToAllVariants( $search );
626 $fallbackSearches = array_diff( array_unique( $fallbackSearches ), [ $search ] );
628 foreach ( $fallbackSearches as $fbs ) {
631 $results->appendAll( $fallbackSearchResult );
632 $fallbackLimit -= $fallbackSearchResult->getSize();
633 if ( $fallbackLimit <= 0 ) {
662 $suggestions->
shrink( $this->limit );
664 $search = trim( $search );
666 $linkBatchFactory = MediaWikiServices::getInstance()->getLinkBatchFactory();
667 $lb = $linkBatchFactory->newLinkBatch( $suggestions->
map(
static function (
SearchSuggestion $sugg ) {
670 $lb->setCaller( __METHOD__ );
677 MediaWikiServices::getInstance()->getStatsdDataFactory()
678 ->updateCount(
'search.completion.missing', $diff );
685 if ( $this->offset === 0 ) {
692 $rescoredResults = $rescorer->rescore( $search, $this->namespaces, $results, $this->limit );
697 $rescoredResults = $results;
700 if ( count( $rescoredResults ) > 0 ) {
701 $found = array_search( $rescoredResults[0], $results );
702 if ( $found ===
false ) {
706 $suggestions->
prepend( $exactMatch );
707 $suggestions->
shrink( $this->limit );
711 $suggestions->
rescore( $found );
725 if ( trim( $search ) ===
'' ) {
742 return $backend->
defaultSearchBackend( $this->namespaces, $search, $this->limit, $this->offset );
787 $models = MediaWikiServices::getInstance()->getContentHandlerFactory()->getContentModels();
789 $seenHandlers =
new SplObjectStorage();
790 foreach ( $models as $model ) {
792 $handler = MediaWikiServices::getInstance()
793 ->getContentHandlerFactory()
794 ->getContentHandler( $model );
800 if ( $seenHandlers->contains( $handler ) ) {
804 $seenHandlers->attach( $handler );
805 $handlerFields = $handler->getFieldsForSearchIndex( $this );
806 foreach ( $handlerFields as $fieldName => $fieldData ) {
807 if ( empty( $fields[$fieldName] ) ) {
808 $fields[$fieldName] = $fieldData;
811 $mergeDef = $fields[$fieldName]->merge( $fieldData );
813 throw new InvalidArgumentException(
"Duplicate field $fieldName for model $model" );
815 $fields[$fieldName] = $mergeDef;
820 $this->
getHookRunner()->onSearchIndexFields( $fields, $this );
832 $this->
getHookRunner()->onSearchResultsAugment( $setAugmentors, $rowAugmentors );
833 if ( !$setAugmentors && !$rowAugmentors ) {
839 foreach ( $rowAugmentors as $name => $row ) {
840 if ( isset( $setAugmentors[$name] ) ) {
841 throw new InvalidArgumentException(
"Both row and set augmentors are defined for $name" );
850 foreach ( $setAugmentors as $name => $augmentor ) {
851 $data = $augmentor->augmentAll( $resultSet );
864 $this->hookContainer = $hookContainer;
865 $this->hookRunner =
new HookRunner( $hookContainer );
875 if ( !$this->hookContainer ) {
879 $this->hookContainer = MediaWikiServices::getInstance()->getHookContainer();
881 return $this->hookContainer;
893 if ( !$this->hookRunner ) {
894 $this->hookRunner =
new HookRunner( $this->getHookContainer() );
896 return $this->hookRunner;
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that a deprecated feature was used.
if(!defined('MW_SETUP_CALLBACK'))
static runner()
Get a HookRunner instance for calling hooks using the new interfaces.
Exception thrown when an unregistered content model is requested.
Null index field - means search engine does not implement this field.
Perform augmentation of each row and return composite result, indexed by ID.
defaultSearchBackend( $namespaces, $search, $limit, $offset)
Unless overridden by PrefixSearchBackend hook...
Contain a class for special pages.
completionSearchBackendOverfetch( $search)
Perform an overfetch of completion search results.
makeSearchFieldMapping( $name, $type)
Create a search field definition.
getNearMatcher(Config $config)
Get service class to finding near matches.
getHookRunner()
Get a HookRunner for running core hooks.
searchTitle( $term)
Perform a title-only search query and return a result set.
processCompletionResults( $search, SearchSuggestionSet $suggestions)
Process completion search results.
getFeatureData( $feature)
Way to retrieve custom data set by setFeatureData or by the engine itself.
update( $id, $title, $text)
Create or update the search index record for the given page.
setNamespaces( $namespaces)
Set which namespaces the search should include.
static parseNamespacePrefixes( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
Parse some common prefixes: all (search everything) or namespace names.
doSearchArchiveTitle( $term)
Perform a title search in the article archive.
array $features
Feature values.
replacePrefixes( $query)
Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces...
textAlreadyUpdatedForIndex()
If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() a...
defaultPrefixSearch( $search)
Simple prefix search for subpages.
augmentSearchResults(ISearchResultSet $resultSet)
Augment search results with extra data.
searchArchiveTitle( $term)
Perform a title search in the article archive.
normalizeText( $string)
When overridden in derived class, performs database-specific conversions on text to be used for searc...
setFeatureData( $feature, $data)
Way to pass custom data for engines.
completionSearchBackend( $search)
Perform a completion search.
getTextFromContent(Title $t, Content $c=null)
Get the raw text for updating the index from a content object Nicer search backends could possibly do...
getProfiles( $profileType, User $user=null)
Get a list of supported profiles.
getSort()
Get the sort direction of the search results.
static defaultNearMatcher()
Get near matcher for default SearchEngine.
getSearchIndexFields()
Get fields for search index.
getValidSorts()
Get the valid sort directions.
static userHighlightPrefs()
Find snippet highlight settings for all users.
updateTitle( $id, $title)
Update a search index record's title only.
completionSearchWithVariants( $search)
Perform a completion search with variants.
doSearchText( $term)
Perform a full text search query and return a result set.
normalizeNamespaces( $search)
Makes search simple string if it was namespaced.
const CHARS_ALL
Integer flag for legalSearchChars: includes all chars allowed in a search query.
getHookContainer()
Get a HookContainer, for running extension hooks or for hook metadata.
completionSearch( $search)
Perform a completion search.
setLimitOffset( $limit, $offset=0)
Set the maximum number of results to return and how many to skip before returning the first.
const CHARS_NO_SYNTAX
Integer flag for legalSearchChars: includes all chars allowed in a search term.
setShowSuggestion( $showSuggestion)
Set whether the searcher should try to build a suggestion.
simplePrefixSearch( $search)
Call out to simple search backend.
setSort( $sort)
Set the sort direction of the search results.
const FT_QUERY_INDEP_PROFILE_TYPE
Profile type for query independent ranking features.
setHookContainer(HookContainer $hookContainer)
searchText( $term)
Perform a full text search query and return a result set.
legalSearchChars( $type=self::CHARS_ALL)
Get chars legal for search.
extractTitles(SearchSuggestionSet $completionResults)
Extract titles from completion results.
const COMPLETION_PROFILE_TYPE
Profile type for completionSearch.
doSearchTitle( $term)
Perform a title-only search query and return a result set.
An utility class to rescore search results by looking for an exact match in the db and add the page f...
const DEFAULT_CONTEXT_LINES
const DEFAULT_CONTEXT_CHARS
A set of search suggestions.
filter( $callback)
Filter the suggestions array.
rescore( $key)
Move the suggestion at index $key to the first position.
shrink( $limit)
Remove any extra elements in the suggestions set.
static fromStrings(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a string array.
static fromTitles(array $titles, $hasMoreResults=false)
Builds a new set of suggestion based on a title array.
static emptySuggestionSet()
map( $callback)
Call array_map on the suggestions array.
prepend(SearchSuggestion $suggestion)
Add a new suggestion at the top.
getSuggestedTitle()
Title object in the case this suggestion is based on a title.
static fromTitle( $score, Title $title)
Create suggestion from Title.
static newGood( $value=null)
Factory function for good results.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Performs prefix search, returning Title objects.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Interface for configuration instances.
Base interface for representing page content.
A set of SearchEngine results.
setAugmentedData( $name, $data)
Sets augmented data for result set.
Marker class for search engines that can handle their own pagination, by reporting in their ISearchRe...