Merge "Add any prior block to BlockIpComplete hook"
[lhc/web/wiklou.git] / includes / api / ApiQuery.php
1 <?php
2 /**
3 *
4 *
5 * Created on Sep 7, 2006
6 *
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
23 *
24 * @file
25 */
26
27 /**
28 * This is the main query class. It behaves similar to ApiMain: based on the
29 * parameters given, it will create a list of titles to work on (an ApiPageSet
30 * object), instantiate and execute various property/list/meta modules, and
31 * assemble all resulting data into a single ApiResult object.
32 *
33 * In generator mode, a generator will be executed first to populate a second
34 * ApiPageSet object, and that object will be used for all subsequent modules.
35 *
36 * @ingroup API
37 */
38 class ApiQuery extends ApiBase {
39
40 /**
41 * List of Api Query prop modules
42 * @var array
43 */
44 private static $QueryPropModules = [
45 'categories' => 'ApiQueryCategories',
46 'categoryinfo' => 'ApiQueryCategoryInfo',
47 'contributors' => 'ApiQueryContributors',
48 'deletedrevisions' => 'ApiQueryDeletedRevisions',
49 'duplicatefiles' => 'ApiQueryDuplicateFiles',
50 'extlinks' => 'ApiQueryExternalLinks',
51 'fileusage' => 'ApiQueryBacklinksprop',
52 'images' => 'ApiQueryImages',
53 'imageinfo' => 'ApiQueryImageInfo',
54 'info' => 'ApiQueryInfo',
55 'links' => 'ApiQueryLinks',
56 'linkshere' => 'ApiQueryBacklinksprop',
57 'iwlinks' => 'ApiQueryIWLinks',
58 'langlinks' => 'ApiQueryLangLinks',
59 'pageprops' => 'ApiQueryPageProps',
60 'redirects' => 'ApiQueryBacklinksprop',
61 'revisions' => 'ApiQueryRevisions',
62 'stashimageinfo' => 'ApiQueryStashImageInfo',
63 'templates' => 'ApiQueryLinks',
64 'transcludedin' => 'ApiQueryBacklinksprop',
65 ];
66
67 /**
68 * List of Api Query list modules
69 * @var array
70 */
71 private static $QueryListModules = [
72 'allcategories' => 'ApiQueryAllCategories',
73 'alldeletedrevisions' => 'ApiQueryAllDeletedRevisions',
74 'allfileusages' => 'ApiQueryAllLinks',
75 'allimages' => 'ApiQueryAllImages',
76 'alllinks' => 'ApiQueryAllLinks',
77 'allpages' => 'ApiQueryAllPages',
78 'allredirects' => 'ApiQueryAllLinks',
79 'allrevisions' => 'ApiQueryAllRevisions',
80 'mystashedfiles' => 'ApiQueryMyStashedFiles',
81 'alltransclusions' => 'ApiQueryAllLinks',
82 'allusers' => 'ApiQueryAllUsers',
83 'backlinks' => 'ApiQueryBacklinks',
84 'blocks' => 'ApiQueryBlocks',
85 'categorymembers' => 'ApiQueryCategoryMembers',
86 'deletedrevs' => 'ApiQueryDeletedrevs',
87 'embeddedin' => 'ApiQueryBacklinks',
88 'exturlusage' => 'ApiQueryExtLinksUsage',
89 'filearchive' => 'ApiQueryFilearchive',
90 'imageusage' => 'ApiQueryBacklinks',
91 'iwbacklinks' => 'ApiQueryIWBacklinks',
92 'langbacklinks' => 'ApiQueryLangBacklinks',
93 'logevents' => 'ApiQueryLogEvents',
94 'pageswithprop' => 'ApiQueryPagesWithProp',
95 'pagepropnames' => 'ApiQueryPagePropNames',
96 'prefixsearch' => 'ApiQueryPrefixSearch',
97 'protectedtitles' => 'ApiQueryProtectedTitles',
98 'querypage' => 'ApiQueryQueryPage',
99 'random' => 'ApiQueryRandom',
100 'recentchanges' => 'ApiQueryRecentChanges',
101 'search' => 'ApiQuerySearch',
102 'tags' => 'ApiQueryTags',
103 'usercontribs' => 'ApiQueryContributions',
104 'users' => 'ApiQueryUsers',
105 'watchlist' => 'ApiQueryWatchlist',
106 'watchlistraw' => 'ApiQueryWatchlistRaw',
107 ];
108
109 /**
110 * List of Api Query meta modules
111 * @var array
112 */
113 private static $QueryMetaModules = [
114 'allmessages' => 'ApiQueryAllMessages',
115 'authmanagerinfo' => 'ApiQueryAuthManagerInfo',
116 'siteinfo' => 'ApiQuerySiteinfo',
117 'userinfo' => 'ApiQueryUserInfo',
118 'filerepoinfo' => 'ApiQueryFileRepoInfo',
119 'tokens' => 'ApiQueryTokens',
120 ];
121
122 /**
123 * @var ApiPageSet
124 */
125 private $mPageSet;
126
127 private $mParams;
128 private $mNamedDB = [];
129 private $mModuleMgr;
130
131 /**
132 * @param ApiMain $main
133 * @param string $action
134 */
135 public function __construct( ApiMain $main, $action ) {
136 parent::__construct( $main, $action );
137
138 $this->mModuleMgr = new ApiModuleManager( $this );
139
140 // Allow custom modules to be added in LocalSettings.php
141 $config = $this->getConfig();
142 $this->mModuleMgr->addModules( self::$QueryPropModules, 'prop' );
143 $this->mModuleMgr->addModules( $config->get( 'APIPropModules' ), 'prop' );
144 $this->mModuleMgr->addModules( self::$QueryListModules, 'list' );
145 $this->mModuleMgr->addModules( $config->get( 'APIListModules' ), 'list' );
146 $this->mModuleMgr->addModules( self::$QueryMetaModules, 'meta' );
147 $this->mModuleMgr->addModules( $config->get( 'APIMetaModules' ), 'meta' );
148
149 Hooks::run( 'ApiQuery::moduleManager', [ $this->mModuleMgr ] );
150
151 // Create PageSet that will process titles/pageids/revids/generator
152 $this->mPageSet = new ApiPageSet( $this );
153 }
154
155 /**
156 * Overrides to return this instance's module manager.
157 * @return ApiModuleManager
158 */
159 public function getModuleManager() {
160 return $this->mModuleMgr;
161 }
162
163 /**
164 * Get the query database connection with the given name.
165 * If no such connection has been requested before, it will be created.
166 * Subsequent calls with the same $name will return the same connection
167 * as the first, regardless of the values of $db and $groups
168 * @param string $name Name to assign to the database connection
169 * @param int $db One of the DB_* constants
170 * @param array $groups Query groups
171 * @return DatabaseBase
172 */
173 public function getNamedDB( $name, $db, $groups ) {
174 if ( !array_key_exists( $name, $this->mNamedDB ) ) {
175 $this->mNamedDB[$name] = wfGetDB( $db, $groups );
176 }
177
178 return $this->mNamedDB[$name];
179 }
180
181 /**
182 * Gets the set of pages the user has requested (or generated)
183 * @return ApiPageSet
184 */
185 public function getPageSet() {
186 return $this->mPageSet;
187 }
188
189 /**
190 * @return ApiFormatRaw|null
191 */
192 public function getCustomPrinter() {
193 // If &exportnowrap is set, use the raw formatter
194 if ( $this->getParameter( 'export' ) &&
195 $this->getParameter( 'exportnowrap' )
196 ) {
197 return new ApiFormatRaw( $this->getMain(),
198 $this->getMain()->createPrinterByName( 'xml' ) );
199 } else {
200 return null;
201 }
202 }
203
204 /**
205 * Query execution happens in the following steps:
206 * #1 Create a PageSet object with any pages requested by the user
207 * #2 If using a generator, execute it to get a new ApiPageSet object
208 * #3 Instantiate all requested modules.
209 * This way the PageSet object will know what shared data is required,
210 * and minimize DB calls.
211 * #4 Output all normalization and redirect resolution information
212 * #5 Execute all requested modules
213 */
214 public function execute() {
215 $this->mParams = $this->extractRequestParams();
216
217 // Instantiate requested modules
218 $allModules = [];
219 $this->instantiateModules( $allModules, 'prop' );
220 $propModules = array_keys( $allModules );
221 $this->instantiateModules( $allModules, 'list' );
222 $this->instantiateModules( $allModules, 'meta' );
223
224 // Filter modules based on continue parameter
225 $continuationManager = new ApiContinuationManager( $this, $allModules, $propModules );
226 $this->setContinuationManager( $continuationManager );
227 $modules = $continuationManager->getRunModules();
228
229 if ( !$continuationManager->isGeneratorDone() ) {
230 // Query modules may optimize data requests through the $this->getPageSet()
231 // object by adding extra fields from the page table.
232 foreach ( $modules as $module ) {
233 $module->requestExtraData( $this->mPageSet );
234 }
235 // Populate page/revision information
236 $this->mPageSet->execute();
237 // Record page information (title, namespace, if exists, etc)
238 $this->outputGeneralPageInfo();
239 } else {
240 $this->mPageSet->executeDryRun();
241 }
242
243 $cacheMode = $this->mPageSet->getCacheMode();
244
245 // Execute all unfinished modules
246 /** @var $module ApiQueryBase */
247 foreach ( $modules as $module ) {
248 $params = $module->extractRequestParams();
249 $cacheMode = $this->mergeCacheMode(
250 $cacheMode, $module->getCacheMode( $params ) );
251 $module->execute();
252 Hooks::run( 'APIQueryAfterExecute', [ &$module ] );
253 }
254
255 // Set the cache mode
256 $this->getMain()->setCacheMode( $cacheMode );
257
258 // Write the continuation data into the result
259 $this->setContinuationManager( null );
260 if ( $this->mParams['rawcontinue'] ) {
261 $data = $continuationManager->getRawContinuation();
262 if ( $data ) {
263 $this->getResult()->addValue( null, 'query-continue', $data,
264 ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
265 }
266 } else {
267 $continuationManager->setContinuationIntoResult( $this->getResult() );
268 }
269 }
270
271 /**
272 * Update a cache mode string, applying the cache mode of a new module to it.
273 * The cache mode may increase in the level of privacy, but public modules
274 * added to private data do not decrease the level of privacy.
275 *
276 * @param string $cacheMode
277 * @param string $modCacheMode
278 * @return string
279 */
280 protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
281 if ( $modCacheMode === 'anon-public-user-private' ) {
282 if ( $cacheMode !== 'private' ) {
283 $cacheMode = 'anon-public-user-private';
284 }
285 } elseif ( $modCacheMode === 'public' ) {
286 // do nothing, if it's public already it will stay public
287 } else { // private
288 $cacheMode = 'private';
289 }
290
291 return $cacheMode;
292 }
293
294 /**
295 * Create instances of all modules requested by the client
296 * @param array $modules To append instantiated modules to
297 * @param string $param Parameter name to read modules from
298 */
299 private function instantiateModules( &$modules, $param ) {
300 $wasPosted = $this->getRequest()->wasPosted();
301 if ( isset( $this->mParams[$param] ) ) {
302 foreach ( $this->mParams[$param] as $moduleName ) {
303 $instance = $this->mModuleMgr->getModule( $moduleName, $param );
304 if ( $instance === null ) {
305 ApiBase::dieDebug( __METHOD__, 'Error instantiating module' );
306 }
307 if ( !$wasPosted && $instance->mustBePosted() ) {
308 $this->dieUsageMsgOrDebug( [ 'mustbeposted', $moduleName ] );
309 }
310 // Ignore duplicates. TODO 2.0: die()?
311 if ( !array_key_exists( $moduleName, $modules ) ) {
312 $modules[$moduleName] = $instance;
313 }
314 }
315 }
316 }
317
318 /**
319 * Appends an element for each page in the current pageSet with the
320 * most general information (id, title), plus any title normalizations
321 * and missing or invalid title/pageids/revids.
322 */
323 private function outputGeneralPageInfo() {
324 $pageSet = $this->getPageSet();
325 $result = $this->getResult();
326
327 // We can't really handle max-result-size failure here, but we need to
328 // check anyway in case someone set the limit stupidly low.
329 $fit = true;
330
331 $values = $pageSet->getNormalizedTitlesAsResult( $result );
332 if ( $values ) {
333 $fit = $fit && $result->addValue( 'query', 'normalized', $values );
334 }
335 $values = $pageSet->getConvertedTitlesAsResult( $result );
336 if ( $values ) {
337 $fit = $fit && $result->addValue( 'query', 'converted', $values );
338 }
339 $values = $pageSet->getInterwikiTitlesAsResult( $result, $this->mParams['iwurl'] );
340 if ( $values ) {
341 $fit = $fit && $result->addValue( 'query', 'interwiki', $values );
342 }
343 $values = $pageSet->getRedirectTitlesAsResult( $result );
344 if ( $values ) {
345 $fit = $fit && $result->addValue( 'query', 'redirects', $values );
346 }
347 $values = $pageSet->getMissingRevisionIDsAsResult( $result );
348 if ( $values ) {
349 $fit = $fit && $result->addValue( 'query', 'badrevids', $values );
350 }
351
352 // Page elements
353 $pages = [];
354
355 // Report any missing titles
356 foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
357 $vals = [];
358 ApiQueryBase::addTitleInfo( $vals, $title );
359 $vals['missing'] = true;
360 $pages[$fakeId] = $vals;
361 }
362 // Report any invalid titles
363 foreach ( $pageSet->getInvalidTitlesAndReasons() as $fakeId => $data ) {
364 $pages[$fakeId] = $data + [ 'invalid' => true ];
365 }
366 // Report any missing page ids
367 foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
368 $pages[$pageid] = [
369 'pageid' => $pageid,
370 'missing' => true
371 ];
372 }
373 // Report special pages
374 /** @var $title Title */
375 foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
376 $vals = [];
377 ApiQueryBase::addTitleInfo( $vals, $title );
378 $vals['special'] = true;
379 if ( $title->isSpecialPage() &&
380 !SpecialPageFactory::exists( $title->getDBkey() )
381 ) {
382 $vals['missing'] = true;
383 } elseif ( $title->getNamespace() == NS_MEDIA &&
384 !wfFindFile( $title )
385 ) {
386 $vals['missing'] = true;
387 }
388 $pages[$fakeId] = $vals;
389 }
390
391 // Output general page information for found titles
392 foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
393 $vals = [];
394 $vals['pageid'] = $pageid;
395 ApiQueryBase::addTitleInfo( $vals, $title );
396 $pages[$pageid] = $vals;
397 }
398
399 if ( count( $pages ) ) {
400 $pageSet->populateGeneratorData( $pages );
401 ApiResult::setArrayType( $pages, 'BCarray' );
402
403 if ( $this->mParams['indexpageids'] ) {
404 $pageIDs = array_keys( ApiResult::stripMetadataNonRecursive( $pages ) );
405 // json treats all map keys as strings - converting to match
406 $pageIDs = array_map( 'strval', $pageIDs );
407 ApiResult::setIndexedTagName( $pageIDs, 'id' );
408 $fit = $fit && $result->addValue( 'query', 'pageids', $pageIDs );
409 }
410
411 ApiResult::setIndexedTagName( $pages, 'page' );
412 $fit = $fit && $result->addValue( 'query', 'pages', $pages );
413 }
414
415 if ( !$fit ) {
416 $this->dieUsage(
417 'The value of $wgAPIMaxResultSize on this wiki is ' .
418 'too small to hold basic result information',
419 'badconfig'
420 );
421 }
422
423 if ( $this->mParams['export'] ) {
424 $this->doExport( $pageSet, $result );
425 }
426 }
427
428 /**
429 * @param ApiPageSet $pageSet Pages to be exported
430 * @param ApiResult $result Result to output to
431 */
432 private function doExport( $pageSet, $result ) {
433 $exportTitles = [];
434 $titles = $pageSet->getGoodTitles();
435 if ( count( $titles ) ) {
436 $user = $this->getUser();
437 /** @var $title Title */
438 foreach ( $titles as $title ) {
439 if ( $title->userCan( 'read', $user ) ) {
440 $exportTitles[] = $title;
441 }
442 }
443 }
444
445 $exporter = new WikiExporter( $this->getDB() );
446 $sink = new DumpStringOutput;
447 $exporter->setOutputSink( $sink );
448 $exporter->openStream();
449 foreach ( $exportTitles as $title ) {
450 $exporter->pageByTitle( $title );
451 }
452 $exporter->closeStream();
453 $exportxml = $sink->getOutput();
454
455 // Don't check the size of exported stuff
456 // It's not continuable, so it would cause more
457 // problems than it'd solve
458 if ( $this->mParams['exportnowrap'] ) {
459 $result->reset();
460 // Raw formatter will handle this
461 $result->addValue( null, 'text', $exportxml, ApiResult::NO_SIZE_CHECK );
462 $result->addValue( null, 'mime', 'text/xml', ApiResult::NO_SIZE_CHECK );
463 } else {
464 $result->addValue( 'query', 'export', $exportxml, ApiResult::NO_SIZE_CHECK );
465 $result->addValue( 'query', ApiResult::META_BC_SUBELEMENTS, [ 'export' ] );
466 }
467 }
468
469 public function getAllowedParams( $flags = 0 ) {
470 $result = [
471 'prop' => [
472 ApiBase::PARAM_ISMULTI => true,
473 ApiBase::PARAM_TYPE => 'submodule',
474 ],
475 'list' => [
476 ApiBase::PARAM_ISMULTI => true,
477 ApiBase::PARAM_TYPE => 'submodule',
478 ],
479 'meta' => [
480 ApiBase::PARAM_ISMULTI => true,
481 ApiBase::PARAM_TYPE => 'submodule',
482 ],
483 'indexpageids' => false,
484 'export' => false,
485 'exportnowrap' => false,
486 'iwurl' => false,
487 'continue' => [
488 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
489 ],
490 'rawcontinue' => false,
491 ];
492 if ( $flags ) {
493 $result += $this->getPageSet()->getFinalParams( $flags );
494 }
495
496 return $result;
497 }
498
499 /**
500 * Override the parent to generate help messages for all available query modules.
501 * @deprecated since 1.25
502 * @return string
503 */
504 public function makeHelpMsg() {
505 wfDeprecated( __METHOD__, '1.25' );
506
507 // Use parent to make default message for the query module
508 $msg = parent::makeHelpMsg();
509
510 $querySeparator = str_repeat( '--- ', 12 );
511 $moduleSeparator = str_repeat( '*** ', 14 );
512 $msg .= "\n$querySeparator Query: Prop $querySeparator\n\n";
513 $msg .= $this->makeHelpMsgHelper( 'prop' );
514 $msg .= "\n$querySeparator Query: List $querySeparator\n\n";
515 $msg .= $this->makeHelpMsgHelper( 'list' );
516 $msg .= "\n$querySeparator Query: Meta $querySeparator\n\n";
517 $msg .= $this->makeHelpMsgHelper( 'meta' );
518 $msg .= "\n\n$moduleSeparator Modules: continuation $moduleSeparator\n\n";
519
520 return $msg;
521 }
522
523 /**
524 * For all modules of a given group, generate help messages and join them together
525 * @deprecated since 1.25
526 * @param string $group Module group
527 * @return string
528 */
529 private function makeHelpMsgHelper( $group ) {
530 $moduleDescriptions = [];
531
532 $moduleNames = $this->mModuleMgr->getNames( $group );
533 sort( $moduleNames );
534 foreach ( $moduleNames as $name ) {
535 /**
536 * @var $module ApiQueryBase
537 */
538 $module = $this->mModuleMgr->getModule( $name );
539
540 $msg = ApiMain::makeHelpMsgHeader( $module, $group );
541 $msg2 = $module->makeHelpMsg();
542 if ( $msg2 !== false ) {
543 $msg .= $msg2;
544 }
545 if ( $module instanceof ApiQueryGeneratorBase ) {
546 $msg .= "Generator:\n This module may be used as a generator\n";
547 }
548 $moduleDescriptions[] = $msg;
549 }
550
551 return implode( "\n", $moduleDescriptions );
552 }
553
554 public function isReadMode() {
555 // We need to make an exception for certain meta modules that should be
556 // accessible even without the 'read' right. Restrict the exception as
557 // much as possible: no other modules allowed, and no pageset
558 // parameters either. We do allow the 'rawcontinue' and 'indexpageids'
559 // parameters since frameworks might add these unconditionally and they
560 // can't expose anything here.
561 $this->mParams = $this->extractRequestParams();
562 $params = array_filter(
563 array_diff_key(
564 $this->mParams + $this->getPageSet()->extractRequestParams(),
565 [ 'rawcontinue' => 1, 'indexpageids' => 1 ]
566 )
567 );
568 if ( array_keys( $params ) !== [ 'meta' ] ) {
569 return true;
570 }
571
572 // Ask each module if it requires read mode. Any true => this returns
573 // true.
574 $modules = [];
575 $this->instantiateModules( $modules, 'meta' );
576 foreach ( $modules as $module ) {
577 if ( $module->isReadMode() ) {
578 return true;
579 }
580 }
581
582 return false;
583 }
584
585 protected function getExamplesMessages() {
586 return [
587 'action=query&prop=revisions&meta=siteinfo&' .
588 'titles=Main%20Page&rvprop=user|comment&continue='
589 => 'apihelp-query-example-revisions',
590 'action=query&generator=allpages&gapprefix=API/&prop=revisions&continue='
591 => 'apihelp-query-example-allpages',
592 ];
593 }
594
595 public function getHelpUrls() {
596 return [
597 'https://www.mediawiki.org/wiki/API:Query',
598 'https://www.mediawiki.org/wiki/API:Meta',
599 'https://www.mediawiki.org/wiki/API:Properties',
600 'https://www.mediawiki.org/wiki/API:Lists',
601 ];
602 }
603 }