<?php
-
-/*
- * Created on Sep 7, 2006
+/**
+ *
*
- * API for MediaWiki 1.8+
+ * Created on Sep 7, 2006
*
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-if (!defined('MEDIAWIKI')) {
- // Eclipse helper - will be ignored in production
- require_once ('ApiBase.php');
-}
+use Wikimedia\Rdbms\IDatabase;
/**
- * This is the main query class. It behaves similar to ApiMain: based on the parameters given,
- * it will create a list of titles to work on (an instance of the ApiPageSet object)
- * instantiate and execute various property/list/meta modules,
- * and assemble all resulting data into a single ApiResult object.
- *
- * In the generator mode, a generator will be first executed to populate a second ApiPageSet object,
- * and that object will be used for all subsequent modules.
- *
- * @addtogroup API
+ * This is the main query class. It behaves similar to ApiMain: based on the
+ * parameters given, it will create a list of titles to work on (an ApiPageSet
+ * object), instantiate and execute various property/list/meta modules, and
+ * assemble all resulting data into a single ApiResult object.
+ *
+ * In generator mode, a generator will be executed first to populate a second
+ * ApiPageSet object, and that object will be used for all subsequent modules.
+ *
+ * @ingroup API
*/
class ApiQuery extends ApiBase {
- private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;
- private $mPageSet;
- private $params, $redirect;
-
- private $mQueryPropModules = array (
+ /**
+ * List of Api Query prop modules
+ * @var array
+ */
+ private static $QueryPropModules = [
+ 'categories' => 'ApiQueryCategories',
+ 'categoryinfo' => 'ApiQueryCategoryInfo',
+ 'contributors' => 'ApiQueryContributors',
+ 'deletedrevisions' => 'ApiQueryDeletedRevisions',
+ 'duplicatefiles' => 'ApiQueryDuplicateFiles',
+ 'extlinks' => 'ApiQueryExternalLinks',
+ 'fileusage' => 'ApiQueryBacklinksprop',
+ 'images' => 'ApiQueryImages',
+ 'imageinfo' => 'ApiQueryImageInfo',
'info' => 'ApiQueryInfo',
- 'revisions' => 'ApiQueryRevisions',
'links' => 'ApiQueryLinks',
+ 'linkshere' => 'ApiQueryBacklinksprop',
+ 'iwlinks' => 'ApiQueryIWLinks',
'langlinks' => 'ApiQueryLangLinks',
- 'images' => 'ApiQueryImages',
- 'imageinfo' => 'ApiQueryImageInfo',
+ 'pageprops' => 'ApiQueryPageProps',
+ 'redirects' => 'ApiQueryBacklinksprop',
+ 'revisions' => 'ApiQueryRevisions',
+ 'stashimageinfo' => 'ApiQueryStashImageInfo',
'templates' => 'ApiQueryLinks',
- 'categories' => 'ApiQueryCategories',
- 'extlinks' => 'ApiQueryExternalLinks',
- );
+ 'transcludedin' => 'ApiQueryBacklinksprop',
+ ];
- private $mQueryListModules = array (
- 'allpages' => 'ApiQueryAllpages',
+ /**
+ * List of Api Query list modules
+ * @var array
+ */
+ private static $QueryListModules = [
+ 'allcategories' => 'ApiQueryAllCategories',
+ 'alldeletedrevisions' => 'ApiQueryAllDeletedRevisions',
+ 'allfileusages' => 'ApiQueryAllLinks',
+ 'allimages' => 'ApiQueryAllImages',
'alllinks' => 'ApiQueryAllLinks',
+ 'allpages' => 'ApiQueryAllPages',
+ 'allredirects' => 'ApiQueryAllLinks',
+ 'allrevisions' => 'ApiQueryAllRevisions',
+ 'mystashedfiles' => 'ApiQueryMyStashedFiles',
+ 'alltransclusions' => 'ApiQueryAllLinks',
'allusers' => 'ApiQueryAllUsers',
'backlinks' => 'ApiQueryBacklinks',
+ 'blocks' => 'ApiQueryBlocks',
'categorymembers' => 'ApiQueryCategoryMembers',
+ 'deletedrevs' => 'ApiQueryDeletedrevs',
'embeddedin' => 'ApiQueryBacklinks',
+ 'exturlusage' => 'ApiQueryExtLinksUsage',
+ 'filearchive' => 'ApiQueryFilearchive',
'imageusage' => 'ApiQueryBacklinks',
+ 'iwbacklinks' => 'ApiQueryIWBacklinks',
+ 'langbacklinks' => 'ApiQueryLangBacklinks',
'logevents' => 'ApiQueryLogEvents',
+ 'pageswithprop' => 'ApiQueryPagesWithProp',
+ 'pagepropnames' => 'ApiQueryPagePropNames',
+ 'prefixsearch' => 'ApiQueryPrefixSearch',
+ 'protectedtitles' => 'ApiQueryProtectedTitles',
+ 'querypage' => 'ApiQueryQueryPage',
+ 'random' => 'ApiQueryRandom',
'recentchanges' => 'ApiQueryRecentChanges',
'search' => 'ApiQuerySearch',
+ 'tags' => 'ApiQueryTags',
'usercontribs' => 'ApiQueryContributions',
+ 'users' => 'ApiQueryUsers',
'watchlist' => 'ApiQueryWatchlist',
- 'exturlusage' => 'ApiQueryExtLinksUsage',
- );
+ 'watchlistraw' => 'ApiQueryWatchlistRaw',
+ ];
- private $mQueryMetaModules = array (
+ /**
+ * List of Api Query meta modules
+ * @var array
+ */
+ private static $QueryMetaModules = [
+ 'allmessages' => 'ApiQueryAllMessages',
+ 'authmanagerinfo' => 'ApiQueryAuthManagerInfo',
'siteinfo' => 'ApiQuerySiteinfo',
'userinfo' => 'ApiQueryUserInfo',
- );
+ 'filerepoinfo' => 'ApiQueryFileRepoInfo',
+ 'tokens' => 'ApiQueryTokens',
+ ];
- private $mSlaveDB = null;
- private $mNamedDB = array();
+ /**
+ * @var ApiPageSet
+ */
+ private $mPageSet;
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
+ private $mParams;
+ private $mNamedDB = [];
+ private $mModuleMgr;
- // Allow custom modules to be added in LocalSettings.php
- global $wgApiQueryPropModules, $wgApiQueryListModules, $wgApiQueryMetaModules;
- self :: appendUserModules($this->mQueryPropModules, $wgApiQueryPropModules);
- self :: appendUserModules($this->mQueryListModules, $wgApiQueryListModules);
- self :: appendUserModules($this->mQueryMetaModules, $wgApiQueryMetaModules);
+ /**
+ * @param ApiMain $main
+ * @param string $action
+ */
+ public function __construct( ApiMain $main, $action ) {
+ parent::__construct( $main, $action );
- $this->mPropModuleNames = array_keys($this->mQueryPropModules);
- $this->mListModuleNames = array_keys($this->mQueryListModules);
- $this->mMetaModuleNames = array_keys($this->mQueryMetaModules);
+ $this->mModuleMgr = new ApiModuleManager( $this );
- // Allow the entire list of modules at first,
- // but during module instantiation check if it can be used as a generator.
- $this->mAllowedGenerators = array_merge($this->mListModuleNames, $this->mPropModuleNames);
- }
+ // Allow custom modules to be added in LocalSettings.php
+ $config = $this->getConfig();
+ $this->mModuleMgr->addModules( self::$QueryPropModules, 'prop' );
+ $this->mModuleMgr->addModules( $config->get( 'APIPropModules' ), 'prop' );
+ $this->mModuleMgr->addModules( self::$QueryListModules, 'list' );
+ $this->mModuleMgr->addModules( $config->get( 'APIListModules' ), 'list' );
+ $this->mModuleMgr->addModules( self::$QueryMetaModules, 'meta' );
+ $this->mModuleMgr->addModules( $config->get( 'APIMetaModules' ), 'meta' );
- /**
- * Helper function to append any add-in modules to the list
- */
- private static function appendUserModules(&$modules, $newModules) {
- if (is_array( $newModules )) {
- foreach ( $newModules as $moduleName => $moduleClass) {
- $modules[$moduleName] = $moduleClass;
- }
- }
+ Hooks::run( 'ApiQuery::moduleManager', [ $this->mModuleMgr ] );
+
+ // Create PageSet that will process titles/pageids/revids/generator
+ $this->mPageSet = new ApiPageSet( $this );
}
/**
- * Gets a default slave database connection object
+ * Overrides to return this instance's module manager.
+ * @return ApiModuleManager
*/
- public function getDB() {
- if (!isset ($this->mSlaveDB)) {
- $this->profileDBIn();
- $this->mSlaveDB = wfGetDB(DB_SLAVE);
- $this->profileDBOut();
- }
- return $this->mSlaveDB;
+ public function getModuleManager() {
+ return $this->mModuleMgr;
}
/**
* Get the query database connection with the given name.
- * If no such connection has been requested before, it will be created.
- * Subsequent calls with the same $name will return the same connection
- * as the first, regardless of $db or $groups new values.
+ * If no such connection has been requested before, it will be created.
+ * Subsequent calls with the same $name will return the same connection
+ * as the first, regardless of the values of $db and $groups
+ * @param string $name Name to assign to the database connection
+ * @param int $db One of the DB_* constants
+ * @param string|string[] $groups Query groups
+ * @return IDatabase
*/
- public function getNamedDB($name, $db, $groups) {
- if (!array_key_exists($name, $this->mNamedDB)) {
- $this->profileDBIn();
- $this->mNamedDB[$name] = wfGetDB($db, $groups);
- $this->profileDBOut();
+ public function getNamedDB( $name, $db, $groups ) {
+ if ( !array_key_exists( $name, $this->mNamedDB ) ) {
+ $this->mNamedDB[$name] = wfGetDB( $db, $groups );
}
+
return $this->mNamedDB[$name];
}
/**
* Gets the set of pages the user has requested (or generated)
+ * @return ApiPageSet
*/
public function getPageSet() {
return $this->mPageSet;
}
+ /**
+ * @return ApiFormatRaw|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;
+ }
+ }
+
/**
* Query execution happens in the following steps:
* #1 Create a PageSet object with any pages requested by the user
- * #2 If using generator, execute it to get a new PageSet object
- * #3 Instantiate all requested modules.
+ * #2 If using a generator, execute it to get a new ApiPageSet object
+ * #3 Instantiate all requested modules.
* This way the PageSet object will know what shared data is required,
- * and minimize DB calls.
+ * and minimize DB calls.
* #4 Output all normalization and redirect resolution information
* #5 Execute all requested modules
*/
public function execute() {
-
- $this->params = $this->extractRequestParams();
- $this->redirects = $this->params['redirects'];
-
- //
- // Create PageSet
- //
- $this->mPageSet = new ApiPageSet($this, $this->redirects);
-
- //
+ $this->mParams = $this->extractRequestParams();
+
// Instantiate requested modules
- //
- $modules = array ();
- $this->InstantiateModules($modules, 'prop', $this->mQueryPropModules);
- $this->InstantiateModules($modules, 'list', $this->mQueryListModules);
- $this->InstantiateModules($modules, 'meta', $this->mQueryMetaModules);
-
- //
- // If given, execute generator to substitute user supplied data with generated data.
- //
- if (isset ($this->params['generator'])) {
- $this->executeGeneratorModule($this->params['generator'], $modules);
- } else {
- // Append custom fields and populate page/revision information
- $this->addCustomFldsToPageSet($modules, $this->mPageSet);
+ $allModules = [];
+ $this->instantiateModules( $allModules, 'prop' );
+ $propModules = array_keys( $allModules );
+ $this->instantiateModules( $allModules, 'list' );
+ $this->instantiateModules( $allModules, 'meta' );
+
+ // Filter modules based on continue parameter
+ $continuationManager = new ApiContinuationManager( $this, $allModules, $propModules );
+ $this->setContinuationManager( $continuationManager );
+ $modules = $continuationManager->getRunModules();
+
+ if ( !$continuationManager->isGeneratorDone() ) {
+ // Query modules may optimize data requests through the $this->getPageSet()
+ // object by adding extra fields from the page table.
+ foreach ( $modules as $module ) {
+ $module->requestExtraData( $this->mPageSet );
+ }
+ // Populate page/revision information
$this->mPageSet->execute();
+ // Record page information (title, namespace, if exists, etc)
+ $this->outputGeneralPageInfo();
+ } else {
+ $this->mPageSet->executeDryRun();
}
- //
- // Record page information (title, namespace, if exists, etc)
- //
- $this->outputGeneralPageInfo();
+ $cacheMode = $this->mPageSet->getCacheMode();
- //
- // Execute all requested modules.
- //
- foreach ($modules as $module) {
- $module->profileIn();
+ // Execute all unfinished modules
+ /** @var ApiQueryBase $module */
+ foreach ( $modules as $module ) {
+ $params = $module->extractRequestParams();
+ $cacheMode = $this->mergeCacheMode(
+ $cacheMode, $module->getCacheMode( $params ) );
$module->execute();
- $module->profileOut();
+ Hooks::run( 'APIQueryAfterExecute', [ &$module ] );
+ }
+
+ // Set the cache mode
+ $this->getMain()->setCacheMode( $cacheMode );
+
+ // Write the continuation data into the result
+ $this->setContinuationManager( null );
+ if ( $this->mParams['rawcontinue'] ) {
+ $data = $continuationManager->getRawNonContinuation();
+ if ( $data ) {
+ $this->getResult()->addValue( null, 'query-noncontinue', $data,
+ ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
+ }
+ $data = $continuationManager->getRawContinuation();
+ if ( $data ) {
+ $this->getResult()->addValue( null, 'query-continue', $data,
+ ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
+ }
+ } else {
+ $continuationManager->setContinuationIntoResult( $this->getResult() );
}
}
-
+
/**
- * Query modules may optimize data requests through the $this->getPageSet() object
- * by adding extra fields from the page table.
- * This function will gather all the extra request fields from the modules.
+ * Update a cache mode string, applying the cache mode of a new module to it.
+ * The cache mode may increase in the level of privacy, but public modules
+ * added to private data do not decrease the level of privacy.
+ *
+ * @param string $cacheMode
+ * @param string $modCacheMode
+ * @return string
*/
- private function addCustomFldsToPageSet($modules, $pageSet) {
- // Query all requested modules.
- foreach ($modules as $module) {
- $module->requestExtraData($pageSet);
+ 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;
}
/**
- * Create instances of all modules requested by the client
+ * Create instances of all modules requested by the client
+ * @param array $modules To append instantiated modules to
+ * @param string $param Parameter name to read modules from
*/
- private function InstantiateModules(&$modules, $param, $moduleList) {
- $list = $this->params[$param];
- if (isset ($list))
- foreach ($list as $moduleName)
- $modules[] = new $moduleList[$moduleName] ($this, $moduleName);
+ private function instantiateModules( &$modules, $param ) {
+ $wasPosted = $this->getRequest()->wasPosted();
+ if ( isset( $this->mParams[$param] ) ) {
+ foreach ( $this->mParams[$param] as $moduleName ) {
+ $instance = $this->mModuleMgr->getModule( $moduleName, $param );
+ if ( $instance === null ) {
+ ApiBase::dieDebug( __METHOD__, 'Error instantiating module' );
+ }
+ if ( !$wasPosted && $instance->mustBePosted() ) {
+ $this->dieWithErrorOrDebug( [ 'apierror-mustbeposted', $moduleName ] );
+ }
+ // Ignore duplicates. TODO 2.0: die()?
+ if ( !array_key_exists( $moduleName, $modules ) ) {
+ $modules[$moduleName] = $instance;
+ }
+ }
+ }
}
/**
- * Appends an element for each page in the current pageSet with the most general
- * information (id, title), plus any title normalizations and missing title/pageids/revids.
+ * Appends an element for each page in the current pageSet with the
+ * most general information (id, title), plus any title normalizations
+ * and missing or invalid title/pageids/revids.
*/
private function outputGeneralPageInfo() {
-
$pageSet = $this->getPageSet();
$result = $this->getResult();
- // Title normalizations
- $normValues = array ();
- foreach ($pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr) {
- $normValues[] = array (
- 'from' => $rawTitleStr,
- 'to' => $titleStr
- );
- }
+ // We can't really handle max-result-size failure here, but we need to
+ // check anyway in case someone set the limit stupidly low.
+ $fit = true;
- if (!empty ($normValues)) {
- $result->setIndexedTagName($normValues, 'n');
- $result->addValue('query', 'normalized', $normValues);
+ $values = $pageSet->getNormalizedTitlesAsResult( $result );
+ if ( $values ) {
+ $fit = $fit && $result->addValue( 'query', 'normalized', $values );
}
-
- // Interwiki titles
- $intrwValues = array ();
- foreach ($pageSet->getInterwikiTitles() as $rawTitleStr => $interwikiStr) {
- $intrwValues[] = array (
- 'title' => $rawTitleStr,
- 'iw' => $interwikiStr
- );
+ $values = $pageSet->getConvertedTitlesAsResult( $result );
+ if ( $values ) {
+ $fit = $fit && $result->addValue( 'query', 'converted', $values );
}
-
- if (!empty ($intrwValues)) {
- $result->setIndexedTagName($intrwValues, 'i');
- $result->addValue('query', 'interwiki', $intrwValues);
- }
-
- // Show redirect information
- $redirValues = array ();
- foreach ($pageSet->getRedirectTitles() as $titleStrFrom => $titleStrTo) {
- $redirValues[] = array (
- 'from' => $titleStrFrom,
- 'to' => $titleStrTo
- );
+ $values = $pageSet->getInterwikiTitlesAsResult( $result, $this->mParams['iwurl'] );
+ if ( $values ) {
+ $fit = $fit && $result->addValue( 'query', 'interwiki', $values );
}
-
- if (!empty ($redirValues)) {
- $result->setIndexedTagName($redirValues, 'r');
- $result->addValue('query', 'redirects', $redirValues);
+ $values = $pageSet->getRedirectTitlesAsResult( $result );
+ if ( $values ) {
+ $fit = $fit && $result->addValue( 'query', 'redirects', $values );
}
-
- //
- // Missing revision elements
- //
- $missingRevIDs = $pageSet->getMissingRevisionIDs();
- if (!empty ($missingRevIDs)) {
- $revids = array ();
- foreach ($missingRevIDs as $revid) {
- $revids[$revid] = array (
- 'revid' => $revid
- );
- }
- $result->setIndexedTagName($revids, 'rev');
- $result->addValue('query', 'badrevids', $revids);
+ $values = $pageSet->getMissingRevisionIDsAsResult( $result );
+ if ( $values ) {
+ $fit = $fit && $result->addValue( 'query', 'badrevids', $values );
}
- //
// Page elements
- //
- $pages = array ();
+ $pages = [];
// Report any missing titles
- foreach ($pageSet->getMissingTitles() as $fakeId => $title) {
- $vals = array();
- ApiQueryBase :: addTitleInfo($vals, $title);
- $vals['missing'] = '';
+ foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
+ $vals = [];
+ ApiQueryBase::addTitleInfo( $vals, $title );
+ $vals['missing'] = true;
+ if ( $title->isKnown() ) {
+ $vals['known'] = true;
+ }
$pages[$fakeId] = $vals;
}
-
+ // Report any invalid titles
+ foreach ( $pageSet->getInvalidTitlesAndReasons() as $fakeId => $data ) {
+ $pages[$fakeId] = $data + [ 'invalid' => true ];
+ }
// Report any missing page ids
- foreach ($pageSet->getMissingPageIDs() as $pageid) {
- $pages[$pageid] = array (
+ foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
+ $pages[$pageid] = [
'pageid' => $pageid,
- 'missing' => ''
- );
+ 'missing' => true,
+ ];
+ }
+ // Report special pages
+ /** @var Title $title */
+ foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
+ $vals = [];
+ ApiQueryBase::addTitleInfo( $vals, $title );
+ $vals['special'] = true;
+ if ( !$title->isKnown() ) {
+ $vals['missing'] = true;
+ }
+ $pages[$fakeId] = $vals;
}
// Output general page information for found titles
- foreach ($pageSet->getGoodTitles() as $pageid => $title) {
- $vals = array();
+ foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
+ $vals = [];
$vals['pageid'] = $pageid;
- ApiQueryBase :: addTitleInfo($vals, $title);
+ ApiQueryBase::addTitleInfo( $vals, $title );
$pages[$pageid] = $vals;
}
- if (!empty ($pages)) {
-
- if ($this->params['indexpageids']) {
- $pageIDs = array_keys($pages);
+ if ( count( $pages ) ) {
+ $pageSet->populateGeneratorData( $pages );
+ ApiResult::setArrayType( $pages, 'BCarray' );
+
+ if ( $this->mParams['indexpageids'] ) {
+ $pageIDs = array_keys( ApiResult::stripMetadataNonRecursive( $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);
+ $pageIDs = array_map( 'strval', $pageIDs );
+ ApiResult::setIndexedTagName( $pageIDs, 'id' );
+ $fit = $fit && $result->addValue( 'query', 'pageids', $pageIDs );
}
-
- $result->setIndexedTagName($pages, 'page');
- $result->addValue('query', 'pages', $pages);
+
+ ApiResult::setIndexedTagName( $pages, 'page' );
+ $fit = $fit && $result->addValue( 'query', 'pages', $pages );
+ }
+
+ if ( !$fit ) {
+ $this->dieWithError( 'apierror-badconfig-resulttoosmall', 'badconfig' );
+ }
+
+ if ( $this->mParams['export'] ) {
+ $this->doExport( $pageSet, $result );
}
}
/**
- * For generator mode, execute generator, and use its output as new pageSet
+ * @param ApiPageSet $pageSet Pages to be exported
+ * @param ApiResult $result Result to output to
*/
- protected function executeGeneratorModule($generatorName, $modules) {
+ private function doExport( $pageSet, $result ) {
+ $exportTitles = [];
+ $titles = $pageSet->getGoodTitles();
+ if ( count( $titles ) ) {
+ $user = $this->getUser();
+ /** @var Title $title */
+ foreach ( $titles as $title ) {
+ if ( $title->userCan( 'read', $user ) ) {
+ $exportTitles[] = $title;
+ }
+ }
+ }
- // Find class that implements requested generator
- if (isset ($this->mQueryListModules[$generatorName])) {
- $className = $this->mQueryListModules[$generatorName];
- } elseif (isset ($this->mQueryPropModules[$generatorName])) {
- $className = $this->mQueryPropModules[$generatorName];
+ $exporter = new WikiExporter( $this->getDB() );
+ $sink = new DumpStringOutput;
+ $exporter->setOutputSink( $sink );
+ $exporter->openStream();
+ foreach ( $exportTitles as $title ) {
+ $exporter->pageByTitle( $title );
+ }
+ $exporter->closeStream();
+
+ // Don't check the size of exported stuff
+ // It's not continuable, so it would cause more
+ // problems than it'd solve
+ if ( $this->mParams['exportnowrap'] ) {
+ $result->reset();
+ // Raw formatter will handle this
+ $result->addValue( null, 'text', $sink, ApiResult::NO_SIZE_CHECK );
+ $result->addValue( null, 'mime', 'text/xml', ApiResult::NO_SIZE_CHECK );
+ $result->addValue( null, 'filename', 'export.xml', ApiResult::NO_SIZE_CHECK );
} else {
- ApiBase :: dieDebug(__METHOD__, "Unknown generator=$generatorName");
+ $result->addValue( 'query', 'export', $sink, ApiResult::NO_SIZE_CHECK );
+ $result->addValue( 'query', ApiResult::META_BC_SUBELEMENTS, [ 'export' ] );
}
-
- // Generator results
- $resultPageSet = new ApiPageSet($this, $this->redirects);
-
- // Create and execute the generator
- $generator = new $className ($this, $generatorName);
- if (!$generator instanceof ApiQueryGeneratorBase)
- $this->dieUsage("Module $generatorName cannot be used as a generator", "badgenerator");
-
- $generator->setGeneratorMode();
-
- // 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);
- $resultPageSet->finishPageSetGeneration();
- $generator->profileOut();
-
- // Swap the resulting pageset back in
- $this->mPageSet = $resultPageSet;
}
- /**
- * Returns the list of allowed parameters for this module.
- * Qurey module also lists all ApiPageSet parameters as its own.
- */
- protected 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,
+ public function getAllowedParams( $flags = 0 ) {
+ $result = [
+ 'prop' => [
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => 'submodule',
+ ],
+ 'list' => [
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => 'submodule',
+ ],
+ 'meta' => [
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => 'submodule',
+ ],
'indexpageids' => false,
- );
- }
-
- /**
- * Override the parent to generate help messages for all available query modules.
- */
- public function makeHelpMsg() {
-
- $msg = '';
-
- // Make sure the internal object is empty
- // (just in case a sub-module decides to optimize during instantiation)
- $this->mPageSet = null;
- $this->mAllowedGenerators = array(); // Will be repopulated
-
- $astriks = str_repeat('--- ', 8);
- $msg .= "\n$astriks Query: Prop $astriks\n\n";
- $msg .= $this->makeHelpMsgHelper($this->mQueryPropModules, 'prop');
- $msg .= "\n$astriks Query: List $astriks\n\n";
- $msg .= $this->makeHelpMsgHelper($this->mQueryListModules, 'list');
- $msg .= "\n$astriks Query: Meta $astriks\n\n";
- $msg .= $this->makeHelpMsgHelper($this->mQueryMetaModules, 'meta');
-
- // Perform the base call last because the $this->mAllowedGenerators
- // will be updated inside makeHelpMsgHelper()
- // Use parent to make default message for the query module
- $msg = parent :: makeHelpMsg() . $msg;
+ 'export' => false,
+ 'exportnowrap' => false,
+ 'iwurl' => false,
+ 'continue' => [
+ ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
+ ],
+ 'rawcontinue' => false,
+ ];
+ if ( $flags ) {
+ $result += $this->getPageSet()->getFinalParams( $flags );
+ }
- return $msg;
+ return $result;
}
- /**
- * For all modules in $moduleList, generate help messages and join them together
- */
- private function makeHelpMsgHelper($moduleList, $paramName) {
-
- $moduleDscriptions = array ();
-
- foreach ($moduleList as $moduleName => $moduleClass) {
- $module = new $moduleClass ($this, $moduleName, null);
+ public function isReadMode() {
+ // We need to make an exception for certain meta modules that should be
+ // accessible even without the 'read' right. Restrict the exception as
+ // much as possible: no other modules allowed, and no pageset
+ // parameters either. We do allow the 'rawcontinue' and 'indexpageids'
+ // parameters since frameworks might add these unconditionally and they
+ // can't expose anything here.
+ $this->mParams = $this->extractRequestParams();
+ $params = array_filter(
+ array_diff_key(
+ $this->mParams + $this->getPageSet()->extractRequestParams(),
+ [ 'rawcontinue' => 1, 'indexpageids' => 1 ]
+ )
+ );
+ if ( array_keys( $params ) !== [ 'meta' ] ) {
+ return true;
+ }
- $msg = ApiMain::makeHelpMsgHeader($module, $paramName);
- $msg2 = $module->makeHelpMsg();
- if ($msg2 !== false)
- $msg .= $msg2;
- if ($module instanceof ApiQueryGeneratorBase) {
- $this->mAllowedGenerators[] = $moduleName;
- $msg .= "Generator:\n This module may be used as a generator\n";
+ // Ask each module if it requires read mode. Any true => this returns
+ // true.
+ $modules = [];
+ $this->instantiateModules( $modules, 'meta' );
+ foreach ( $modules as $module ) {
+ if ( $module->isReadMode() ) {
+ return true;
}
- $moduleDscriptions[] = $msg;
}
- return implode("\n", $moduleDscriptions);
+ return false;
}
- /**
- * Override to add extra parameters from PageSet
- */
- public function makeHelpMsgParameters() {
- $psModule = new ApiPageSet($this);
- return $psModule->makeHelpMsgParameters() . parent :: makeHelpMsgParameters();
+ protected function getExamplesMessages() {
+ return [
+ 'action=query&prop=revisions&meta=siteinfo&' .
+ 'titles=Main%20Page&rvprop=user|comment&continue='
+ => 'apihelp-query-example-revisions',
+ 'action=query&generator=allpages&gapprefix=API/&prop=revisions&continue='
+ => 'apihelp-query-example-allpages',
+ ];
}
- protected function getParamDescription() {
- return array (
- 'prop' => 'Which properties to get for the titles/revisions/pageids',
- 'list' => 'Which lists to get',
- 'meta' => 'Which meta data to get about the site',
- 'generator' => 'Use the output of a list as the input for other prop/list/meta items',
- 'redirects' => 'Automatically resolve redirects',
- 'indexpageids' => 'Include an additional pageids section listing all returned page IDs.'
- );
- }
-
- protected 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 Query API interface currently available on all MediaWiki servers.',
- 'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.'
- );
- }
-
- protected function getExamples() {
- return array (
- 'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment'
- );
- }
-
- public function getVersion() {
- $psModule = new ApiPageSet($this);
- $vers = array ();
- $vers[] = __CLASS__ . ': $Id: ApiQuery.php 24494 2007-07-31 17:53:37Z yurik $';
- $vers[] = $psModule->getVersion();
- return $vers;
+ public function getHelpUrls() {
+ return [
+ 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Query',
+ 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Meta',
+ 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Properties',
+ 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Lists',
+ ];
}
}
-
scripts.mit.edu / autoinstalls / mediawiki.git / blobdiff