}
/**
- * 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.
+ * 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 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.
+ * 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
*/
'exturlusage' => 'ApiQueryExtLinksUsage',
'users' => 'ApiQueryUsers',
'random' => 'ApiQueryRandom',
+ 'protectedtitles' => 'ApiQueryProtectedTitles',
);
private $mQueryMetaModules = array (
/**
* Helper function to append any add-in modules to the list
+ * @param $modules array Module array
+ * @param $newModules array Module array to add to $modules
*/
private static function appendUserModules(&$modules, $newModules) {
if (is_array( $newModules )) {
/**
* Gets a default slave database connection object
+ * @return Database
*/
public function getDB() {
if (!isset ($this->mSlaveDB)) {
* 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.
+ * as the first, regardless of the values of $db and $groups
+ * @param $name string Name to assign to the database connection
+ * @param $db int One of the DB_* constants
+ * @param $groups array Query groups
+ * @return Database
*/
public function getNamedDB($name, $db, $groups) {
if (!array_key_exists($name, $this->mNamedDB)) {
/**
* Gets the set of pages the user has requested (or generated)
+ * @return ApiPageSet
*/
public function getPageSet() {
return $this->mPageSet;
/**
* Get the array mapping module names to class names
+ * @return array(modulename => classname)
*/
function getModules() {
return array_merge($this->mQueryPropModules, $this->mQueryListModules, $this->mQueryMetaModules);
}
+
+ 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
+ * #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.
$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'])) {
- $this->executeGeneratorModule($this->params['generator'], $modules);
+ 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);
// 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 );
+ }
+
+ /**
+ * 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.
+ */
+ 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;
}
/**
* 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.
+ * @param $modules array of module objects
+ * @param $pageSet ApiPageSet
*/
private function addCustomFldsToPageSet($modules, $pageSet) {
// Query all requested modules.
/**
* Create instances of all modules requested by the client
+ * @param $modules array to append instatiated modules to
+ * @param $param string Parameter name to read modules from
+ * @param $moduleList array(modulename => classname)
*/
private function InstantiateModules(&$modules, $param, $moduleList) {
$list = @$this->params[$param];
}
/**
- * 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.
+ * 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();
+ # 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) {
}
$result->setIndexedTagName($pages, 'page');
- $result->addValue('query', 'pages', $pages);
+ $result->addValue('query', 'pages', $pages);
+ }
+ if ($this->params['export']) {
+ $exporter = new WikiExporter($this->getDB());
+ // WikiExporter writes to stdout, so catch its
+ // output with an ob
+ ob_start();
+ $exporter->openStream();
+ foreach (@$pageSet->getGoodTitles() as $title)
+ if ($title->userCanRead())
+ $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();
}
}
/**
- * For generator mode, execute generator, and use its output as new pageSet
+ * Create a generator object of the given type and return it
*/
- protected function executeGeneratorModule($generatorName, $modules) {
-
+ public function newGenerator( $generatorName ) {
// Find class that implements requested generator
if (isset ($this->mQueryListModules[$generatorName])) {
$className = $this->mQueryListModules[$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;
+ }
+
+ /**
+ * For generator mode, execute generator, and use its output as new
+ * ApiPageSet
+ * @param $generatorName string Module name
+ * @param $modules array of module objects
+ */
+ 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->mPageSet = $resultPageSet;
}
- /**
- * Returns the list of allowed parameters for this module.
- * Qurey module also lists all ApiPageSet parameters as its own.
- */
public function getAllowedParams() {
return array (
'prop' => array (
),
'redirects' => false,
'indexpageids' => false,
+ 'export' => false,
+ 'exportnowrap' => false,
);
}
/**
* Override the parent to generate help messages for all available query modules.
+ * @return string
*/
public function makeHelpMsg() {
/**
* For all modules in $moduleList, generate help messages and join them together
+ * @param $moduleList array(modulename => classname)
+ * @param $paramName string Parameter name
+ * @return string
*/
private function makeHelpMsgHelper($moduleList, $paramName) {
- $moduleDscriptions = array ();
+ $moduleDescriptions = array ();
foreach ($moduleList as $moduleName => $moduleClass) {
$module = new $moduleClass ($this, $moduleName, null);
$this->mAllowedGenerators[] = $moduleName;
$msg .= "Generator:\n This module may be used as a generator\n";
}
- $moduleDscriptions[] = $msg;
+ $moduleDescriptions[] = $msg;
}
- return implode("\n", $moduleDscriptions);
+ return implode("\n", $moduleDescriptions);
}
/**
* Override to add extra parameters from PageSet
+ * @return string
*/
public function makeHelpMsgParameters() {
$psModule = new ApiPageSet($this);
'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',
+ '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',
- 'indexpageids' => 'Include an additional pageids section listing all returned page IDs.'
+ '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',
);
}
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 Query API interface currently available on all MediaWiki servers.',
+ '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.'
);
}
protected function getExamples() {
return array (
- 'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment'
+ '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 getVersion() {
$psModule = new ApiPageSet($this);
$vers = array ();
- $vers[] = __CLASS__ . ': $Id: ApiQuery.php 42548 2008-10-25 14:04:43Z tstarling $';
+ $vers[] = __CLASS__ . ': $Id: ApiQuery.php 69986 2010-07-27 03:57:39Z tstarling $';
$vers[] = $psModule->getVersion();
return $vers;
}
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff