48 private const QUERY_PROP_MODULES = [
50 'class' => ApiQueryCategories::class,
53 'class' => ApiQueryCategoryInfo::class,
56 'class' => ApiQueryContributors::class,
61 'GroupPermissionsLookup',
65 'deletedrevisions' => [
66 'class' => ApiQueryDeletedRevisions::class,
69 'ContentHandlerFactory',
82 'class' => ApiQueryDuplicateFiles::class,
88 'class' => ApiQueryExternalLinks::class,
94 'class' => ApiQueryBacklinksprop::class,
101 'class' => ApiQueryImages::class,
104 'class' => ApiQueryImageInfo::class,
113 'class' => ApiQueryInfo::class,
121 'LanguageConverterFactory',
126 'IntroMessageBuilder',
127 'PreloadedContentBuilder',
133 'class' => ApiQueryLinks::class,
141 'class' => ApiQueryBacklinksprop::class,
148 'class' => ApiQueryIWLinks::class,
154 'class' => ApiQueryLangLinks::class,
162 'class' => ApiQueryPageProps::class,
168 'class' => ApiQueryBacklinksprop::class,
175 'class' => ApiQueryRevisions::class,
178 'ContentHandlerFactory',
184 'ContentTransformer',
190 'stashimageinfo' => [
191 'class' => ApiQueryStashImageInfo::class,
200 'class' => ApiQueryLinks::class,
208 'class' => ApiQueryBacklinksprop::class,
219 private const QUERY_LIST_MODULES = [
221 'class' => ApiQueryAllCategories::class,
223 'alldeletedrevisions' => [
224 'class' => ApiQueryAllDeletedRevisions::class,
227 'ContentHandlerFactory',
233 'ContentTransformer',
240 'class' => ApiQueryAllLinks::class,
249 'class' => ApiQueryAllImages::class,
252 'GroupPermissionsLookup',
256 'class' => ApiQueryAllLinks::class,
265 'class' => ApiQueryAllPages::class,
273 'class' => ApiQueryAllLinks::class,
282 'class' => ApiQueryAllRevisions::class,
285 'ContentHandlerFactory',
291 'ContentTransformer',
297 'mystashedfiles' => [
298 'class' => ApiQueryMyStashedFiles::class,
300 'alltransclusions' => [
301 'class' => ApiQueryAllLinks::class,
310 'class' => ApiQueryAllUsers::class,
314 'GroupPermissionsLookup',
319 'class' => ApiQueryBacklinks::class,
325 'class' => ApiQueryBlocks::class,
327 'DatabaseBlockStore',
329 'BlockRestrictionStore',
334 'categorymembers' => [
335 'class' => ApiQueryCategoryMembers::class,
341 'class' => ApiQueryDeletedrevs::class,
344 'RowCommentFormatter',
351 'class' => ApiQueryBacklinks::class,
357 'class' => ApiQueryExtLinksUsage::class,
363 'class' => ApiQueryFilearchive::class,
370 'class' => ApiQueryBacklinks::class,
376 'class' => ApiQueryIWBacklinks::class,
379 'class' => ApiQueryLangBacklinks::class,
382 'class' => ApiQueryLogEvents::class,
385 'RowCommentFormatter',
391 'class' => ApiQueryPagesWithProp::class,
394 'class' => ApiQueryPagePropNames::class,
397 'class' => ApiQueryPrefixSearch::class,
399 'SearchEngineConfig',
400 'SearchEngineFactory',
403 'protectedtitles' => [
404 'class' => ApiQueryProtectedTitles::class,
407 'RowCommentFormatter'
411 'class' => ApiQueryQueryPage::class,
413 'SpecialPageFactory',
417 'class' => ApiQueryRandom::class,
420 'class' => ApiQueryRecentChanges::class,
423 'RowCommentFormatter',
431 'class' => ApiQuerySearch::class,
433 'SearchEngineConfig',
434 'SearchEngineFactory',
439 'class' => ApiQueryTags::class,
445 'class' => ApiQueryUserContribs::class,
448 'UserIdentityLookup',
457 'class' => ApiQueryUsers::class,
467 'class' => ApiQueryWatchlist::class,
470 'WatchedItemQueryService',
479 'class' => ApiQueryWatchlistRaw::class,
481 'WatchedItemQueryService',
492 private const QUERY_META_MODULES = [
494 'class' => ApiQueryAllMessages::class,
503 'authmanagerinfo' => [
504 'class' => ApiQueryAuthManagerInfo::class,
510 'class' => ApiQuerySiteinfo::class,
514 'LanguageConverterFactory',
522 'SpecialPageFactory',
530 'class' => ApiQueryUserInfo::class,
532 'TalkPageNotificationManager',
540 'class' => ApiQueryFileRepoInfo::class,
546 'class' => ApiQueryTokens::class,
549 'class' => ApiQueryLanguageinfo::class,
554 'LanguageConverterFactory',
582 ObjectFactory $objectFactory,
587 parent::__construct( $main, $action );
596 $this->mModuleMgr->addModules( self::QUERY_PROP_MODULES,
'prop' );
597 $this->mModuleMgr->addModules( $config->get( MainConfigNames::APIPropModules ),
'prop' );
598 $this->mModuleMgr->addModules( self::QUERY_LIST_MODULES,
'list' );
599 $this->mModuleMgr->addModules( $config->get( MainConfigNames::APIListModules ),
'list' );
600 $this->mModuleMgr->addModules( self::QUERY_META_MODULES,
'meta' );
601 $this->mModuleMgr->addModules( $config->get( MainConfigNames::APIMetaModules ),
'meta' );
603 $this->
getHookRunner()->onApiQuery__moduleManager( $this->mModuleMgr );
607 $this->wikiExporterFactory = $wikiExporterFactory;
608 $this->titleFormatter = $titleFormatter;
609 $this->titleFactory = $titleFactory;
617 return $this->mModuleMgr;
625 return $this->mPageSet;
637 $this->
getMain()->createPrinterByName(
'xml' ) );
658 $this->instantiateModules( $allModules,
'prop' );
659 $propModules = array_keys( $allModules );
660 $this->instantiateModules( $allModules,
'list' );
661 $this->instantiateModules( $allModules,
'meta' );
667 $modules = $continuationManager->getRunModules();
668 '@phan-var ApiQueryBase[] $modules';
670 $statsFactory = MediaWikiServices::getInstance()->getStatsFactory();
672 if ( !$continuationManager->isGeneratorDone() ) {
675 foreach ( $modules as $module ) {
677 $timer = $statsFactory->getTiming(
'api_query_extraDataTiming_seconds' )
678 ->setLabel(
'module', $module->getModuleName() )
679 ->copyToStatsdAt(
'api-query.' . $module->getModuleName() .
'.extraDataTiming' );
681 $module->requestExtraData( $this->mPageSet );
685 $this->mPageSet->execute();
687 $this->outputGeneralPageInfo();
689 $this->mPageSet->executeDryRun();
692 $cacheMode = $this->mPageSet->getCacheMode();
695 foreach ( $modules as $module ) {
697 $timer = $statsFactory->getTiming(
'api_query_executeTiming_seconds' )
698 ->setLabel(
'module', $module->getModuleName() )
699 ->copyToStatsdAt(
'api-query.' . $module->getModuleName() .
'.executeTiming' );
702 $params = $module->extractRequestParams();
704 $cacheMode, $module->getCacheMode(
$params ) );
713 $this->
getMain()->setCacheMode( $cacheMode );
717 if ( $this->mParams[
'rawcontinue'] ) {
718 $data = $continuationManager->getRawNonContinuation();
720 $this->
getResult()->addValue(
null,
'query-noncontinue', $data,
721 ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
723 $data = $continuationManager->getRawContinuation();
725 $this->
getResult()->addValue(
null,
'query-continue', $data,
726 ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
729 $continuationManager->setContinuationIntoResult( $this->
getResult() );
743 if ( $modCacheMode ===
'anon-public-user-private' ) {
744 if ( $cacheMode !==
'private' ) {
745 $cacheMode =
'anon-public-user-private';
747 } elseif ( $modCacheMode ===
'public' ) {
750 $cacheMode =
'private';
761 private function instantiateModules( &$modules, $param ) {
762 $wasPosted = $this->
getRequest()->wasPosted();
763 if ( isset( $this->mParams[$param] ) ) {
764 foreach ( $this->mParams[$param] as $moduleName ) {
765 $instance = $this->mModuleMgr->getModule( $moduleName, $param );
766 if ( $instance ===
null ) {
767 ApiBase::dieDebug( __METHOD__,
'Error instantiating module' );
769 if ( !$wasPosted && $instance->mustBePosted() ) {
773 if ( !array_key_exists( $moduleName, $modules ) ) {
785 private function outputGeneralPageInfo() {
793 $values = $pageSet->getNormalizedTitlesAsResult( $result );
796 $fit = $fit && $result->addValue(
'query',
'normalized', $values );
798 $values = $pageSet->getConvertedTitlesAsResult( $result );
800 $fit = $fit && $result->addValue(
'query',
'converted', $values );
802 $values = $pageSet->getInterwikiTitlesAsResult( $result, $this->mParams[
'iwurl'] );
804 $fit = $fit && $result->addValue(
'query',
'interwiki', $values );
806 $values = $pageSet->getRedirectTitlesAsResult( $result );
808 $fit = $fit && $result->addValue(
'query',
'redirects', $values );
810 $values = $pageSet->getMissingRevisionIDsAsResult( $result );
812 $fit = $fit && $result->addValue(
'query',
'badrevids', $values );
820 foreach ( $pageSet->getMissingPages() as $fakeId => $page ) {
822 $vals[
'ns'] = $page->getNamespace();
823 $vals[
'title'] = $this->titleFormatter->getPrefixedText( $page );
824 $vals[
'missing'] =
true;
825 $title = $this->titleFactory->newFromPageIdentity( $page );
826 if ( $title->isKnown() ) {
827 $vals[
'known'] =
true;
829 $pages[$fakeId] = $vals;
832 foreach ( $pageSet->getInvalidTitlesAndReasons() as $fakeId => $data ) {
833 $pages[$fakeId] = $data + [
'invalid' => true ];
836 foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
844 foreach ( $pageSet->getSpecialPages() as $fakeId => $page ) {
846 $vals[
'ns'] = $page->getNamespace();
847 $vals[
'title'] = $this->titleFormatter->getPrefixedText( $page );
848 $vals[
'special'] =
true;
849 $title = $this->titleFactory->newFromPageReference( $page );
850 if ( !$title->isKnown() ) {
851 $vals[
'missing'] =
true;
853 $pages[$fakeId] = $vals;
857 foreach ( $pageSet->getGoodPages() as $pageid => $page ) {
859 $vals[
'pageid'] = $pageid;
860 $vals[
'ns'] = $page->getNamespace();
861 $vals[
'title'] = $this->titleFormatter->getPrefixedText( $page );
862 $pages[$pageid] = $vals;
865 if ( count( $pages ) ) {
866 $pageSet->populateGeneratorData( $pages );
869 if ( $this->mParams[
'indexpageids'] ) {
870 $pageIDs = array_keys( ApiResult::stripMetadataNonRecursive( $pages ) );
872 $pageIDs = array_map(
'strval', $pageIDs );
874 $fit = $fit && $result->addValue(
'query',
'pageids', $pageIDs );
878 $fit = $fit && $result->addValue(
'query',
'pages', $pages );
882 $this->
dieWithError(
'apierror-badconfig-resulttoosmall',
'badconfig' );
885 if ( $this->mParams[
'export'] ) {
886 $this->doExport( $pageSet, $result );
894 private function doExport( $pageSet, $result ) {
896 $titles = $pageSet->getGoodPages();
897 if ( count( $titles ) ) {
899 foreach ( $titles as $title ) {
900 if ( $this->
getAuthority()->authorizeRead(
'read', $title ) ) {
901 $exportTitles[] = $title;
906 $exporter = $this->wikiExporterFactory->getWikiExporter( $this->
getDB() );
908 $exporter->setOutputSink( $sink );
909 $exporter->setSchemaVersion( $this->mParams[
'exportschema'] );
910 $exporter->openStream();
911 foreach ( $exportTitles as $title ) {
912 $exporter->pageByTitle( $title );
914 $exporter->closeStream();
919 if ( $this->mParams[
'exportnowrap'] ) {
922 $result->addValue(
null,
'text', $sink, ApiResult::NO_SIZE_CHECK );
923 $result->addValue(
null,
'mime',
'text/xml', ApiResult::NO_SIZE_CHECK );
924 $result->addValue(
null,
'filename',
'export.xml', ApiResult::NO_SIZE_CHECK );
926 $result->addValue(
'query',
'export', $sink, ApiResult::NO_SIZE_CHECK );
927 $result->addValue(
'query', ApiResult::META_BC_SUBELEMENTS, [
'export' ] );
934 ParamValidator::PARAM_ISMULTI =>
true,
935 ParamValidator::PARAM_TYPE =>
'submodule',
938 ParamValidator::PARAM_ISMULTI =>
true,
939 ParamValidator::PARAM_TYPE =>
'submodule',
942 ParamValidator::PARAM_ISMULTI =>
true,
943 ParamValidator::PARAM_TYPE =>
'submodule',
945 'indexpageids' =>
false,
947 'exportnowrap' =>
false,
949 ParamValidator::PARAM_DEFAULT => WikiExporter::schemaVersion(),
950 ParamValidator::PARAM_TYPE => XmlDumpWriter::$supportedSchemas,
956 'rawcontinue' =>
false,
959 $result += $this->
getPageSet()->getFinalParams( $flags );
972 $allowedParams = [
'rawcontinue' => 1,
'indexpageids' => 1 ];
976 $needed = $param ===
'meta';
977 if ( !isset( $allowedParams[$param] ) && $request->getCheck( $param ) !== $needed ) {
985 $this->instantiateModules( $modules,
'meta' );
986 foreach ( $modules as $module ) {
987 if ( $module->isReadMode() ) {
996 $title = Title::newMainPage()->getPrefixedText();
997 $mp = rawurlencode( $title );
1000 'action=query&prop=revisions&meta=siteinfo&' .
1001 "titles={$mp}&rvprop=user|comment&continue="
1002 =>
'apihelp-query-example-revisions',
1003 'action=query&generator=allpages&gapprefix=API/&prop=revisions&continue='
1004 =>
'apihelp-query-example-allpages',
1010 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Query',
1011 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Meta',
1012 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Properties',
1013 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Lists',