MediaWiki REL1_30
ApiQuerySearch.php
Go to the documentation of this file.
1<?php
33 use SearchApi;
34
37
38 public function __construct( ApiQuery $query, $moduleName ) {
39 parent::__construct( $query, $moduleName, 'sr' );
40 }
41
42 public function execute() {
43 $this->run();
44 }
45
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
48 }
49
54 private function run( $resultPageSet = null ) {
55 global $wgContLang;
57
58 // Extract parameters
59 $query = $params['search'];
60 $what = $params['what'];
61 $interwiki = $params['interwiki'];
62 $searchInfo = array_flip( $params['info'] );
63 $prop = array_flip( $params['prop'] );
64
65 // Create search engine instance and set options
66 $search = $this->buildSearchEngine( $params );
67 $search->setFeatureData( 'rewrite', (bool)$params['enablerewrites'] );
68 $search->setFeatureData( 'interwiki', (bool)$interwiki );
69
70 $query = $search->transformSearchTerm( $query );
71 $query = $search->replacePrefixes( $query );
72
73 // Perform the actual search
74 if ( $what == 'text' ) {
75 $matches = $search->searchText( $query );
76 } elseif ( $what == 'title' ) {
77 $matches = $search->searchTitle( $query );
78 } elseif ( $what == 'nearmatch' ) {
79 // near matches must receive the user input as provided, otherwise
80 // the near matches within namespaces are lost.
81 $matches = $search->getNearMatcher( $this->getConfig() )
82 ->getNearMatchResultSet( $params['search'] );
83 } else {
84 // We default to title searches; this is a terrible legacy
85 // of the way we initially set up the MySQL fulltext-based
86 // search engine with separate title and text fields.
87 // In the future, the default should be for a combined index.
88 $what = 'title';
89 $matches = $search->searchTitle( $query );
90
91 // Not all search engines support a separate title search,
92 // for instance the Lucene-based engine we use on Wikipedia.
93 // In this case, fall back to full-text search (which will
94 // include titles in it!)
95 if ( is_null( $matches ) ) {
96 $what = 'text';
97 $matches = $search->searchText( $query );
98 }
99 }
100
101 if ( $matches instanceof Status ) {
103 $matches = $status->getValue();
104 } else {
105 $status = null;
106 }
107
108 if ( $status ) {
109 if ( $status->isOK() ) {
110 $this->getMain()->getErrorFormatter()->addMessagesFromStatus(
111 $this->getModuleName(),
112 $status
113 );
114 } else {
115 $this->dieStatus( $status );
116 }
117 } elseif ( is_null( $matches ) ) {
118 $this->dieWithError( [ 'apierror-searchdisabled', $what ], "search-{$what}-disabled" );
119 }
120
121 if ( $resultPageSet === null ) {
122 $apiResult = $this->getResult();
123 // Add search meta data to result
124 if ( isset( $searchInfo['totalhits'] ) ) {
125 $totalhits = $matches->getTotalHits();
126 if ( $totalhits !== null ) {
127 $apiResult->addValue( [ 'query', 'searchinfo' ],
128 'totalhits', $totalhits );
129 }
130 }
131 if ( isset( $searchInfo['suggestion'] ) && $matches->hasSuggestion() ) {
132 $apiResult->addValue( [ 'query', 'searchinfo' ],
133 'suggestion', $matches->getSuggestionQuery() );
134 $apiResult->addValue( [ 'query', 'searchinfo' ],
135 'suggestionsnippet', $matches->getSuggestionSnippet() );
136 }
137 if ( isset( $searchInfo['rewrittenquery'] ) && $matches->hasRewrittenQuery() ) {
138 $apiResult->addValue( [ 'query', 'searchinfo' ],
139 'rewrittenquery', $matches->getQueryAfterRewrite() );
140 $apiResult->addValue( [ 'query', 'searchinfo' ],
141 'rewrittenquerysnippet', $matches->getQueryAfterRewriteSnippet() );
142 }
143 }
144
145 // Add the search results to the result
146 $terms = $wgContLang->convertForSearchResult( $matches->termMatches() );
147 $titles = [];
148 $count = 0;
149 $result = $matches->next();
150 $limit = $params['limit'];
151
152 while ( $result ) {
153 if ( ++$count > $limit ) {
154 // We've reached the one extra which shows that there are
155 // additional items to be had. Stop here...
156 $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
157 break;
158 }
159
160 // Silently skip broken and missing titles
161 if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
162 $result = $matches->next();
163 continue;
164 }
165
166 if ( $resultPageSet === null ) {
167 $vals = $this->getSearchResultData( $result, $prop, $terms );
168 if ( $vals ) {
169 // Add item to results and see whether it fits
170 $fit = $apiResult->addValue( [ 'query', $this->getModuleName() ], null, $vals );
171 if ( !$fit ) {
172 $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
173 break;
174 }
175 }
176 } else {
177 $titles[] = $result->getTitle();
178 }
179
180 $result = $matches->next();
181 }
182
183 // Here we assume interwiki results do not count with
184 // regular search results. We may want to reconsider this
185 // if we ever return a lot of interwiki results or want pagination
186 // for them.
187 // Interwiki results inside main result set
188 $canAddInterwiki = (bool)$params['enablerewrites'] && ( $resultPageSet === null );
189 if ( $canAddInterwiki ) {
190 $this->addInterwikiResults( $matches, $apiResult, $prop, $terms, 'additional',
191 SearchResultSet::INLINE_RESULTS );
192 }
193
194 // Interwiki results outside main result set
195 if ( $interwiki && $resultPageSet === null ) {
196 $this->addInterwikiResults( $matches, $apiResult, $prop, $terms, 'interwiki',
197 SearchResultSet::SECONDARY_RESULTS );
198 }
199
200 if ( $resultPageSet === null ) {
201 $apiResult->addIndexedTagName( [
202 'query', $this->getModuleName()
203 ], 'p' );
204 } else {
205 $resultPageSet->setRedirectMergePolicy( function ( $current, $new ) {
206 if ( !isset( $current['index'] ) || $new['index'] < $current['index'] ) {
207 $current['index'] = $new['index'];
208 }
209 return $current;
210 } );
211 $resultPageSet->populateFromTitles( $titles );
212 $offset = $params['offset'] + 1;
213 foreach ( $titles as $index => $title ) {
214 $resultPageSet->setGeneratorData( $title, [ 'index' => $index + $offset ] );
215 }
216 }
217 }
218
226 private function getSearchResultData( SearchResult $result, $prop, $terms ) {
227 // Silently skip broken and missing titles
228 if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
229 return null;
230 }
231
232 $vals = [];
233
234 $title = $result->getTitle();
235 ApiQueryBase::addTitleInfo( $vals, $title );
236 $vals['pageid'] = $title->getArticleID();
237
238 if ( isset( $prop['size'] ) ) {
239 $vals['size'] = $result->getByteSize();
240 }
241 if ( isset( $prop['wordcount'] ) ) {
242 $vals['wordcount'] = $result->getWordCount();
243 }
244 if ( isset( $prop['snippet'] ) ) {
245 $vals['snippet'] = $result->getTextSnippet( $terms );
246 }
247 if ( isset( $prop['timestamp'] ) ) {
248 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $result->getTimestamp() );
249 }
250 if ( isset( $prop['titlesnippet'] ) ) {
251 $vals['titlesnippet'] = $result->getTitleSnippet();
252 }
253 if ( isset( $prop['categorysnippet'] ) ) {
254 $vals['categorysnippet'] = $result->getCategorySnippet();
255 }
256 if ( !is_null( $result->getRedirectTitle() ) ) {
257 if ( isset( $prop['redirecttitle'] ) ) {
258 $vals['redirecttitle'] = $result->getRedirectTitle()->getPrefixedText();
259 }
260 if ( isset( $prop['redirectsnippet'] ) ) {
261 $vals['redirectsnippet'] = $result->getRedirectSnippet();
262 }
263 }
264 if ( !is_null( $result->getSectionTitle() ) ) {
265 if ( isset( $prop['sectiontitle'] ) ) {
266 $vals['sectiontitle'] = $result->getSectionTitle()->getFragment();
267 }
268 if ( isset( $prop['sectionsnippet'] ) ) {
269 $vals['sectionsnippet'] = $result->getSectionSnippet();
270 }
271 }
272 if ( isset( $prop['isfilematch'] ) ) {
273 $vals['isfilematch'] = $result->isFileMatch();
274 }
275 return $vals;
276 }
277
288 private function addInterwikiResults(
289 SearchResultSet $matches, ApiResult $apiResult, $prop,
290 $terms, $section, $type
291 ) {
292 $totalhits = null;
293 if ( $matches->hasInterwikiResults( $type ) ) {
294 foreach ( $matches->getInterwikiResults( $type ) as $interwikiMatches ) {
295 // Include number of results if requested
296 $totalhits += $interwikiMatches->getTotalHits();
297
298 $result = $interwikiMatches->next();
299 while ( $result ) {
300 $title = $result->getTitle();
301 $vals = $this->getSearchResultData( $result, $prop, $terms );
302
303 $vals['namespace'] = $result->getInterwikiNamespaceText();
304 $vals['title'] = $title->getText();
305 $vals['url'] = $title->getFullURL();
306
307 // Add item to results and see whether it fits
308 $fit = $apiResult->addValue( [
309 'query',
310 $section . $this->getModuleName(),
311 $result->getInterwikiPrefix()
312 ], null, $vals );
313
314 if ( !$fit ) {
315 // We hit the limit. We can't really provide any meaningful
316 // pagination info so just bail out
317 break;
318 }
319
320 $result = $interwikiMatches->next();
321 }
322 }
323 if ( $totalhits !== null ) {
324 $apiResult->addValue( [ 'query', $section . 'searchinfo' ], 'totalhits', $totalhits );
325 $apiResult->addIndexedTagName( [
326 'query', $section . $this->getModuleName()
327 ], 'p' );
328 }
329 }
330 return $totalhits;
331 }
332
333 public function getCacheMode( $params ) {
334 return 'public';
335 }
336
337 public function getAllowedParams() {
338 if ( $this->allowedParams !== null ) {
340 }
341
342 $this->allowedParams = $this->buildCommonApiParams() + [
343 'what' => [
345 'title',
346 'text',
347 'nearmatch',
348 ]
349 ],
350 'info' => [
351 ApiBase::PARAM_DFLT => 'totalhits|suggestion|rewrittenquery',
353 'totalhits',
354 'suggestion',
355 'rewrittenquery',
356 ],
358 ],
359 'prop' => [
360 ApiBase::PARAM_DFLT => 'size|wordcount|timestamp|snippet',
362 'size',
363 'wordcount',
364 'timestamp',
365 'snippet',
366 'titlesnippet',
367 'redirecttitle',
368 'redirectsnippet',
369 'sectiontitle',
370 'sectionsnippet',
371 'isfilematch',
372 'categorysnippet',
373 'score', // deprecated
374 'hasrelated', // deprecated
375 ],
379 'score' => true,
380 'hasrelated' => true
381 ],
382 ],
383 'interwiki' => false,
384 'enablerewrites' => false,
385 ];
386
388 }
389
390 public function getSearchProfileParams() {
391 return [
392 'qiprofile' => [
393 'profile-type' => SearchEngine::FT_QUERY_INDEP_PROFILE_TYPE,
394 'help-message' => 'apihelp-query+search-param-qiprofile',
395 ],
396 ];
397 }
398
399 protected function getExamplesMessages() {
400 return [
401 'action=query&list=search&srsearch=meaning'
402 => 'apihelp-query+search-example-simple',
403 'action=query&list=search&srwhat=text&srsearch=meaning'
404 => 'apihelp-query+search-example-text',
405 'action=query&generator=search&gsrsearch=meaning&prop=info'
406 => 'apihelp-query+search-example-generator',
407 ];
408 }
409
410 public function getHelpUrls() {
411 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Search';
412 }
413}
and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a and you may at your option offer warranty protection in exchange for a fee You may modify your copy or copies of the Program or any portion of thus forming a work based on the and copy and distribute such modifications or work under the terms of Section provided that you also meet all of these that in whole or in part contains or is derived from the Program or any part to be licensed as a whole at no charge to all third parties under the terms of this License c If the modified program normally reads commands interactively when run
Definition COPYING.txt:104
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
buildSearchEngine(array $params=null)
Build the search engine to use.
buildCommonApiParams( $isScrollable=true)
The set of api parameters that are shared between api calls that call the SearchEngine.
Definition SearchApi.php:46
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1855
const PARAM_DEPRECATED_VALUES
(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.
Definition ApiBase.php:205
getMain()
Get the main module.
Definition ApiBase.php:528
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:91
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:52
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:740
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:160
getResult()
Get the result object.
Definition ApiBase.php:632
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition ApiBase.php:1920
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:55
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Query module to perform full text search within wiki titles and content.
run( $resultPageSet=null)
getSearchResultData(SearchResult $result, $prop, $terms)
Assemble search result data.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getHelpUrls()
Return links to more detailed help pages about the module.
getExamplesMessages()
Returns usage examples for this module.
__construct(ApiQuery $query, $moduleName)
addInterwikiResults(SearchResultSet $matches, ApiResult $apiResult, $prop, $terms, $section, $type)
Add interwiki results as a section in query results.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
executeGenerator( $resultPageSet)
Execute this module as a generator.
array $allowedParams
list of api allowed params
This is the main query class.
Definition ApiQuery.php:40
This class represents the result of the API operations.
Definition ApiResult.php:33
getConfig()
Get the Config object.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:1976
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1049
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition hooks.txt:2990
trait SearchApi
Traits for API components that use a SearchEngine.
Definition SearchApi.php:28
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
$params