ApiQuery.php

Go to the documentation of this file.

<?php
class ApiQuery extends ApiBase {

        private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;

        private $mPageSet;

        private $params, $redirects, $convertTitles, $iwUrl;

        private $mQueryPropModules = array(
                'categories' => 'ApiQueryCategories',
                'categoryinfo' => 'ApiQueryCategoryInfo',
                'duplicatefiles' => 'ApiQueryDuplicateFiles',
                'extlinks' => 'ApiQueryExternalLinks',
                'images' => 'ApiQueryImages',
                'imageinfo' => 'ApiQueryImageInfo',
                'info' => 'ApiQueryInfo',
                'links' => 'ApiQueryLinks',
                'iwlinks' => 'ApiQueryIWLinks',
                'langlinks' => 'ApiQueryLangLinks',
                'pageprops' => 'ApiQueryPageProps',
                'revisions' => 'ApiQueryRevisions',
                'stashimageinfo' => 'ApiQueryStashImageInfo',
                'templates' => 'ApiQueryLinks',
        );

        private $mQueryListModules = array(
                'allcategories' => 'ApiQueryAllCategories',
                'allimages' => 'ApiQueryAllImages',
                'alllinks' => 'ApiQueryAllLinks',
                'allpages' => 'ApiQueryAllPages',
                'allusers' => 'ApiQueryAllUsers',
                'backlinks' => 'ApiQueryBacklinks',
                'blocks' => 'ApiQueryBlocks',
                'categorymembers' => 'ApiQueryCategoryMembers',
                'deletedrevs' => 'ApiQueryDeletedrevs',
                'embeddedin' => 'ApiQueryBacklinks',
                'exturlusage' => 'ApiQueryExtLinksUsage',
                'filearchive' => 'ApiQueryFilearchive',
                'imageusage' => 'ApiQueryBacklinks',
                'iwbacklinks' => 'ApiQueryIWBacklinks',
                'langbacklinks' => 'ApiQueryLangBacklinks',
                'logevents' => 'ApiQueryLogEvents',
                'protectedtitles' => 'ApiQueryProtectedTitles',
                'querypage' => 'ApiQueryQueryPage',
                'random' => 'ApiQueryRandom',
                'recentchanges' => 'ApiQueryRecentChanges',
                'search' => 'ApiQuerySearch',
                'tags' => 'ApiQueryTags',
                'usercontribs' => 'ApiQueryContributions',
                'users' => 'ApiQueryUsers',
                'watchlist' => 'ApiQueryWatchlist',
                'watchlistraw' => 'ApiQueryWatchlistRaw',
        );

        private $mQueryMetaModules = array(
                'allmessages' => 'ApiQueryAllMessages',
                'siteinfo' => 'ApiQuerySiteinfo',
                'userinfo' => 'ApiQueryUserInfo',
        );

        private $mQueryGenerators = array(
                'allcategories' => 'ApiQueryAllCategories',
                'allimages' => 'ApiQueryAllImages',
                'alllinks' => 'ApiQueryAllLinks',
                'allpages' => 'ApiQueryAllPages',
                'backlinks' => 'ApiQueryBacklinks',
                'categories' => 'ApiQueryCategories',
                'categorymembers' => 'ApiQueryCategoryMembers',
                'duplicatefiles' => 'ApiQueryDuplicateFiles',
                'embeddedin' => 'ApiQueryBacklinks',
                'exturlusage' => 'ApiQueryExtLinksUsage',
                'images' => 'ApiQueryImages',
                'imageusage' => 'ApiQueryBacklinks',
                'iwbacklinks' => 'ApiQueryIWBacklinks',
                'langbacklinks' => 'ApiQueryLangBacklinks',
                'links' => 'ApiQueryLinks',
                'protectedtitles' => 'ApiQueryProtectedTitles',
                'querypage' => 'ApiQueryQueryPage',
                'random' => 'ApiQueryRandom',
                'recentchanges' => 'ApiQueryRecentChanges',
                'search' => 'ApiQuerySearch',
                'templates' => 'ApiQueryLinks',
                'watchlist' => 'ApiQueryWatchlist',
                'watchlistraw' => 'ApiQueryWatchlistRaw',
        );

        private $mSlaveDB = null;
        private $mNamedDB = array();

        protected $mAllowedGenerators;

        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );

                // Allow custom modules to be added in LocalSettings.php
                global $wgAPIPropModules, $wgAPIListModules, $wgAPIMetaModules, $wgAPIGeneratorModules;
                self::appendUserModules( $this->mQueryPropModules, $wgAPIPropModules );
                self::appendUserModules( $this->mQueryListModules, $wgAPIListModules );
                self::appendUserModules( $this->mQueryMetaModules, $wgAPIMetaModules );
                self::appendUserModules( $this->mQueryGenerators, $wgAPIGeneratorModules );

                $this->mPropModuleNames = array_keys( $this->mQueryPropModules );
                $this->mListModuleNames = array_keys( $this->mQueryListModules );
                $this->mMetaModuleNames = array_keys( $this->mQueryMetaModules );
                $this->mAllowedGenerators = array_keys( $this->mQueryGenerators );
        }

        private static function appendUserModules( &$modules, $newModules ) {
                if ( is_array( $newModules ) ) {
                        foreach ( $newModules as $moduleName => $moduleClass ) {
                                $modules[$moduleName] = $moduleClass;
                        }
                }
        }

        public function getDB() {
                if ( !isset( $this->mSlaveDB ) ) {
                        $this->profileDBIn();
                        $this->mSlaveDB = wfGetDB( DB_SLAVE, 'api' );
                        $this->profileDBOut();
                }
                return $this->mSlaveDB;
        }

        public function getNamedDB( $name, $db, $groups ) {
                if ( !array_key_exists( $name, $this->mNamedDB ) ) {
                        $this->profileDBIn();
                        $this->mNamedDB[$name] = wfGetDB( $db, $groups );
                        $this->profileDBOut();
                }
                return $this->mNamedDB[$name];
        }

        public function getPageSet() {
                return $this->mPageSet;
        }

        public function getModules() {
                return array_merge( $this->mQueryPropModules, $this->mQueryListModules, $this->mQueryMetaModules );
        }

        public function getGenerators() {
                return $this->mQueryGenerators;
        }

        function getModuleType( $moduleName ) {
                if ( isset( $this->mQueryPropModules[$moduleName] ) ) {
                        return 'prop';
                }

                if ( isset( $this->mQueryListModules[$moduleName] ) ) {
                        return 'list';
                }

                if ( isset( $this->mQueryMetaModules[$moduleName] ) ) {
                        return 'meta';
                }

                return null;
        }

        public function getCustomPrinter() {
                // If &exportnowrap is set, use the raw formatter
                if ( $this->getParameter( 'export' ) &&
                                $this->getParameter( 'exportnowrap' ) )
                {
                        return new ApiFormatRaw( $this->getMain(),
                                $this->getMain()->createPrinterByName( 'xml' ) );
                } else {
                        return null;
                }
        }

        public function execute() {
                $this->params = $this->extractRequestParams();
                $this->redirects = $this->params['redirects'];
                $this->convertTitles = $this->params['converttitles'];
                $this->iwUrl = $this->params['iwurl'];

                // Create PageSet
                $this->mPageSet = new ApiPageSet( $this, $this->redirects, $this->convertTitles );

                // Instantiate requested modules
                $modules = array();
                $this->instantiateModules( $modules, 'prop', $this->mQueryPropModules );
                $this->instantiateModules( $modules, 'list', $this->mQueryListModules );
                $this->instantiateModules( $modules, 'meta', $this->mQueryMetaModules );

                $cacheMode = 'public';

                // If given, execute generator to substitute user supplied data with generated data.
                if ( isset( $this->params['generator'] ) ) {
                        $generator = $this->newGenerator( $this->params['generator'] );
                        $params = $generator->extractRequestParams();
                        $cacheMode = $this->mergeCacheMode( $cacheMode,
                                $generator->getCacheMode( $params ) );
                        $this->executeGeneratorModule( $generator, $modules );
                } else {
                        // Append custom fields and populate page/revision information
                        $this->addCustomFldsToPageSet( $modules, $this->mPageSet );
                        $this->mPageSet->execute();
                }

                // Record page information (title, namespace, if exists, etc)
                $this->outputGeneralPageInfo();

                // Execute all requested modules.
                foreach ( $modules as $module ) {
                        $params = $module->extractRequestParams();
                        $cacheMode = $this->mergeCacheMode(
                                $cacheMode, $module->getCacheMode( $params ) );
                        $module->profileIn();
                        $module->execute();
                        wfRunHooks( 'APIQueryAfterExecute', array( &$module ) );
                        $module->profileOut();
                }

                // Set the cache mode
                $this->getMain()->setCacheMode( $cacheMode );
        }

        protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
                if ( $modCacheMode === 'anon-public-user-private' ) {
                        if ( $cacheMode !== 'private' ) {
                                $cacheMode = 'anon-public-user-private';
                        }
                } elseif ( $modCacheMode === 'public' ) {
                        // do nothing, if it's public already it will stay public
                } else { // private
                        $cacheMode = 'private';
                }
                return $cacheMode;
        }

        private function addCustomFldsToPageSet( $modules, $pageSet ) {
                // Query all requested modules.
                foreach ( $modules as $module ) {
                        $module->requestExtraData( $pageSet );
                }
        }

        private function instantiateModules( &$modules, $param, $moduleList ) {
                if ( isset( $this->params[$param] ) ) {
                        foreach ( $this->params[$param] as $moduleName ) {
                                $modules[] = new $moduleList[$moduleName] ( $this, $moduleName );
                        }
                }
        }

        private function outputGeneralPageInfo() {
                $pageSet = $this->getPageSet();
                $result = $this->getResult();

                // We don't check for a full result set here because we can't be adding
                // more than 380K. The maximum revision size is in the megabyte range,
                // and the maximum result size must be even higher than that.

                // Title normalizations
                $normValues = array();
                foreach ( $pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr ) {
                        $normValues[] = array(
                                'from' => $rawTitleStr,
                                'to' => $titleStr
                        );
                }

                if ( count( $normValues ) ) {
                        $result->setIndexedTagName( $normValues, 'n' );
                        $result->addValue( 'query', 'normalized', $normValues );
                }

                // Title conversions
                $convValues = array();
                foreach ( $pageSet->getConvertedTitles() as $rawTitleStr => $titleStr ) {
                        $convValues[] = array(
                                'from' => $rawTitleStr,
                                'to' => $titleStr
                        );
                }

                if ( count( $convValues ) ) {
                        $result->setIndexedTagName( $convValues, 'c' );
                        $result->addValue( 'query', 'converted', $convValues );
                }

                // Interwiki titles
                $intrwValues = array();
                foreach ( $pageSet->getInterwikiTitles() as $rawTitleStr => $interwikiStr ) {
                        $item = array(
                                'title' => $rawTitleStr,
                                'iw' => $interwikiStr,
                        );
                        if ( $this->iwUrl ) {
                                $title = Title::newFromText( $rawTitleStr );
                                $item['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
                        }
                        $intrwValues[] = $item;
                }

                if ( count( $intrwValues ) ) {
                        $result->setIndexedTagName( $intrwValues, 'i' );
                        $result->addValue( 'query', 'interwiki', $intrwValues );
                }

                // Show redirect information
                $redirValues = array();
                foreach ( $pageSet->getRedirectTitles() as $titleStrFrom => $titleTo ) {
                        $r = array(
                                'from' => strval( $titleStrFrom ),
                                'to' => $titleTo->getPrefixedText(),
                        );
                        if ( $titleTo->getFragment() !== '' ) {
                                $r['tofragment'] = $titleTo->getFragment();
                        }
                        $redirValues[] = $r;
                }

                if ( count( $redirValues ) ) {
                        $result->setIndexedTagName( $redirValues, 'r' );
                        $result->addValue( 'query', 'redirects', $redirValues );
                }

                // Missing revision elements
                $missingRevIDs = $pageSet->getMissingRevisionIDs();
                if ( count( $missingRevIDs ) ) {
                        $revids = array();
                        foreach ( $missingRevIDs as $revid ) {
                                $revids[$revid] = array(
                                        'revid' => $revid
                                );
                        }
                        $result->setIndexedTagName( $revids, 'rev' );
                        $result->addValue( 'query', 'badrevids', $revids );
                }

                // Page elements
                $pages = array();

                // Report any missing titles
                foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
                        $vals = array();
                        ApiQueryBase::addTitleInfo( $vals, $title );
                        $vals['missing'] = '';
                        $pages[$fakeId] = $vals;
                }
                // Report any invalid titles
                foreach ( $pageSet->getInvalidTitles() as $fakeId => $title ) {
                        $pages[$fakeId] = array( 'title' => $title, 'invalid' => '' );
                }
                // Report any missing page ids
                foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
                        $pages[$pageid] = array(
                                'pageid' => $pageid,
                                'missing' => ''
                        );
                }
                // Report special pages
                foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
                        $vals = array();
                        ApiQueryBase::addTitleInfo( $vals, $title );
                        $vals['special'] = '';
                        if ( $title->isSpecialPage() &&
                                        !SpecialPageFactory::exists( $title->getDbKey() ) ) {
                                $vals['missing'] = '';
                        } elseif ( $title->getNamespace() == NS_MEDIA &&
                                        !wfFindFile( $title ) ) {
                                $vals['missing'] = '';
                        }
                        $pages[$fakeId] = $vals;
                }

                // Output general page information for found titles
                foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
                        $vals = array();
                        $vals['pageid'] = $pageid;
                        ApiQueryBase::addTitleInfo( $vals, $title );
                        $pages[$pageid] = $vals;
                }

                if ( count( $pages ) ) {
                        if ( $this->params['indexpageids'] ) {
                                $pageIDs = array_keys( $pages );
                                // json treats all map keys as strings - converting to match
                                $pageIDs = array_map( 'strval', $pageIDs );
                                $result->setIndexedTagName( $pageIDs, 'id' );
                                $result->addValue( 'query', 'pageids', $pageIDs );
                        }

                        $result->setIndexedTagName( $pages, 'page' );
                        $result->addValue( 'query', 'pages', $pages );
                }
                if ( $this->params['export'] ) {
                        $this->doExport( $pageSet, $result );
                }
        }

        private function doExport( $pageSet, $result ) {
                $exportTitles = array();
                $titles = $pageSet->getGoodTitles();
                if ( count( $titles ) ) {
                        $user = $this->getUser();
                        foreach ( $titles as $title ) {
                                if ( $title->userCan( 'read', $user ) ) {
                                        $exportTitles[] = $title;
                                }
                        }
                }

                $exporter = new WikiExporter( $this->getDB() );
                // WikiExporter writes to stdout, so catch its
                // output with an ob
                ob_start();
                $exporter->openStream();
                foreach ( $exportTitles as $title ) {
                        $exporter->pageByTitle( $title );
                }
                $exporter->closeStream();
                $exportxml = ob_get_contents();
                ob_end_clean();

                // Don't check the size of exported stuff
                // It's not continuable, so it would cause more
                // problems than it'd solve
                $result->disableSizeCheck();
                if ( $this->params['exportnowrap'] ) {
                        $result->reset();
                        // Raw formatter will handle this
                        $result->addValue( null, 'text', $exportxml );
                        $result->addValue( null, 'mime', 'text/xml' );
                } else {
                        $r = array();
                        ApiResult::setContent( $r, $exportxml );
                        $result->addValue( 'query', 'export', $r );
                }
                $result->enableSizeCheck();
        }

        public function newGenerator( $generatorName ) {
                // Find class that implements requested generator
                if ( isset( $this->mQueryListModules[$generatorName] ) ) {
                        $className = $this->mQueryListModules[$generatorName];
                } elseif ( isset( $this->mQueryPropModules[$generatorName] ) ) {
                        $className = $this->mQueryPropModules[$generatorName];
                } else {
                        ApiBase::dieDebug( __METHOD__, "Unknown generator=$generatorName" );
                }
                $generator = new $className ( $this, $generatorName );
                if ( !$generator instanceof ApiQueryGeneratorBase ) {
                        $this->dieUsage( "Module $generatorName cannot be used as a generator", 'badgenerator' );
                }
                $generator->setGeneratorMode();
                return $generator;
        }

        protected function executeGeneratorModule( $generator, $modules ) {
                // Generator results
                $resultPageSet = new ApiPageSet( $this, $this->redirects, $this->convertTitles );

                // Add any additional fields modules may need
                $generator->requestExtraData( $this->mPageSet );
                $this->addCustomFldsToPageSet( $modules, $resultPageSet );

                // Populate page information with the original user input
                $this->mPageSet->execute();

                // populate resultPageSet with the generator output
                $generator->profileIn();
                $generator->executeGenerator( $resultPageSet );
                wfRunHooks( 'APIQueryGeneratorAfterExecute', array( &$generator, &$resultPageSet ) );
                $resultPageSet->finishPageSetGeneration();
                $generator->profileOut();

                // Swap the resulting pageset back in
                $this->mPageSet = $resultPageSet;
        }

        public function getAllowedParams() {
                return array(
                        'prop' => array(
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_TYPE => $this->mPropModuleNames
                        ),
                        'list' => array(
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_TYPE => $this->mListModuleNames
                        ),
                        'meta' => array(
                                ApiBase::PARAM_ISMULTI => true,
                                ApiBase::PARAM_TYPE => $this->mMetaModuleNames
                        ),
                        'generator' => array(
                                ApiBase::PARAM_TYPE => $this->mAllowedGenerators
                        ),
                        'redirects' => false,
                        'converttitles' => false,
                        'indexpageids' => false,
                        'export' => false,
                        'exportnowrap' => false,
                        'iwurl' => false,
                );
        }

        public function makeHelpMsg() {
                // Make sure the internal object is empty
                // (just in case a sub-module decides to optimize during instantiation)
                $this->mPageSet = null;

                $querySeparator = str_repeat( '--- ', 12 );
                $moduleSeparator = str_repeat( '*** ', 14 );
                $msg = "\n$querySeparator Query: Prop  $querySeparator\n\n";
                $msg .= $this->makeHelpMsgHelper( $this->mQueryPropModules, 'prop' );
                $msg .= "\n$querySeparator Query: List  $querySeparator\n\n";
                $msg .= $this->makeHelpMsgHelper( $this->mQueryListModules, 'list' );
                $msg .= "\n$querySeparator Query: Meta  $querySeparator\n\n";
                $msg .= $this->makeHelpMsgHelper( $this->mQueryMetaModules, 'meta' );
                $msg .= "\n\n$moduleSeparator Modules: continuation  $moduleSeparator\n\n";

                // Use parent to make default message for the query module
                $msg = parent::makeHelpMsg() . $msg;

                return $msg;
        }

        private function makeHelpMsgHelper( $moduleList, $paramName ) {
                $moduleDescriptions = array();

                foreach ( $moduleList as $moduleName => $moduleClass ) {
                        $module = new $moduleClass( $this, $moduleName, null );

                        $msg = ApiMain::makeHelpMsgHeader( $module, $paramName );
                        $msg2 = $module->makeHelpMsg();
                        if ( $msg2 !== false ) {
                                $msg .= $msg2;
                        }
                        if ( $module instanceof ApiQueryGeneratorBase ) {
                                $msg .= "Generator:\n  This module may be used as a generator\n";
                        }
                        $moduleDescriptions[] = $msg;
                }

                return implode( "\n", $moduleDescriptions );
        }

        public function makeHelpMsgParameters() {
                $psModule = new ApiPageSet( $this );
                return $psModule->makeHelpMsgParameters() . parent::makeHelpMsgParameters();
        }

        public function shouldCheckMaxlag() {
                return true;
        }

        public function getParamDescription() {
                return array(
                        'prop' => 'Which properties to get for the titles/revisions/pageids. Module help is available below',
                        'list' => 'Which lists to get. Module help is available below',
                        'meta' => 'Which metadata to get about the site. Module help is available below',
                        'generator' => array( 'Use the output of a list as the input for other prop/list/meta items',
                                        'NOTE: generator parameter names must be prefixed with a \'g\', see examples' ),
                        'redirects' => 'Automatically resolve redirects',
                        'converttitles' => array( "Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion.",
                                        'Languages that support variant conversion include ' . implode( ', ', LanguageConverter::$languagesWithVariants ) ),
                        'indexpageids' => 'Include an additional pageids section listing all returned page IDs',
                        'export' => 'Export the current revisions of all given or generated pages',
                        'exportnowrap' => 'Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export',
                        'iwurl' => 'Whether to get the full URL if the title is an interwiki link',
                );
        }

        public function getDescription() {
                return array(
                        'Query API module allows applications to get needed pieces of data from the MediaWiki databases,',
                        'and is loosely based on the old query.php interface.',
                        'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites'
                );
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'code' => 'badgenerator', 'info' => 'Module $generatorName cannot be used as a generator' ),
                ) );
        }

        public function getExamples() {
                return array(
                        'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment',
                        'api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions',
                );
        }

        public function getHelpUrls() {
                return array(
                        'https://www.mediawiki.org/wiki/API:Meta',
                        'https://www.mediawiki.org/wiki/API:Properties',
                        'https://www.mediawiki.org/wiki/API:Lists',
                );
        }

        public function getVersion() {
                $psModule = new ApiPageSet( $this );
                $vers = array();
                $vers[] = __CLASS__ . ': $Id$';
                $vers[] = $psModule->getVersion();
                return $vers;
        }
}