Aktualisierung auf Version 1.8.1

1 files changed, 354 insertions, 0 deletions

diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php
new file mode 100644
index 00000000..985bde63
--- /dev/null
+++ b/includes/api/ApiQuery.php
@@ -0,0 +1,354 @@
+<?php
+
+
+/*
+ * Created on Sep 7, 2006
+ *
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+if (!defined('MEDIAWIKI')) {
+	// Eclipse helper - will be ignored in production
+	require_once ('ApiBase.php');
+}
+
+class ApiQuery extends ApiBase {
+
+	private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;
+	private $mPageSet;
+
+	private $mQueryPropModules = array (
+		'info' => 'ApiQueryInfo',
+		'revisions' => 'ApiQueryRevisions'
+	);
+	//	'categories' => 'ApiQueryCategories',
+	//	'imageinfo' => 'ApiQueryImageinfo',
+	//	'langlinks' => 'ApiQueryLanglinks',
+	//	'links' => 'ApiQueryLinks',
+	//	'templates' => 'ApiQueryTemplates',
+
+	private $mQueryListModules = array (
+		'allpages' => 'ApiQueryAllpages'
+	);
+	//	'backlinks' => 'ApiQueryBacklinks',
+	//	'categorymembers' => 'ApiQueryCategorymembers',
+	//	'embeddedin' => 'ApiQueryEmbeddedin',
+	//	'imagelinks' => 'ApiQueryImagelinks',
+	//	'logevents' => 'ApiQueryLogevents',
+	//	'recentchanges' => 'ApiQueryRecentchanges',
+	//	'usercontribs' => 'ApiQueryUsercontribs',
+	//	'users' => 'ApiQueryUsers',
+	//	'watchlist' => 'ApiQueryWatchlist',
+
+	private $mQueryMetaModules = array (
+		'siteinfo' => 'ApiQuerySiteinfo'
+	);
+	//	'userinfo' => 'ApiQueryUserinfo',
+
+	private $mSlaveDB = null;
+
+	public function __construct($main, $action) {
+		parent :: __construct($main, $action);
+		$this->mPropModuleNames = array_keys($this->mQueryPropModules);
+		$this->mListModuleNames = array_keys($this->mQueryListModules);
+		$this->mMetaModuleNames = array_keys($this->mQueryMetaModules);
+
+		// 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);
+	}
+
+	public function getDB() {
+		if (!isset ($this->mSlaveDB))
+			$this->mSlaveDB = & wfGetDB(DB_SLAVE);
+		return $this->mSlaveDB;
+	}
+
+	public function getPageSet() {
+		return $this->mPageSet;
+	}
+
+	/**
+	 * 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. 
+	 *    This way the PageSet object will know what shared data is required,
+	 *    and minimize DB calls. 
+	 * #4 Output all normalization and redirect resolution information
+	 * #5 Execute all requested modules
+	 */
+	public function execute() {
+		$prop = $list = $meta = $generator = $redirects = null;
+		extract($this->extractRequestParams());
+
+		//
+		// Create PageSet
+		//
+		$this->mPageSet = new ApiPageSet($this, $redirects);
+
+		// Instantiate required modules
+		$modules = array ();
+		if (isset ($prop))
+			foreach ($prop as $moduleName)
+				$modules[] = new $this->mQueryPropModules[$moduleName] ($this, $moduleName);
+		if (isset ($list))
+			foreach ($list as $moduleName)
+				$modules[] = new $this->mQueryListModules[$moduleName] ($this, $moduleName);
+		if (isset ($meta))
+			foreach ($meta as $moduleName)
+				$modules[] = new $this->mQueryMetaModules[$moduleName] ($this, $moduleName);
+
+		// Modules may optimize data requests through the $this->getPageSet() object 
+		// Execute all requested modules.
+		foreach ($modules as $module) {
+			$module->requestExtraData();
+		}
+
+		//
+		// If given, execute generator to substitute user supplied data with generated data.  
+		//
+		if (isset ($generator))
+			$this->executeGeneratorModule($generator, $redirects);
+
+		//
+		// Populate page information for the given pageSet
+		//
+		$this->mPageSet->execute();
+
+		//
+		// Record page information (title, namespace, if exists, etc)
+		//
+		$this->outputGeneralPageInfo();
+
+		//
+		// Execute all requested modules.
+		//
+		foreach ($modules as $module) {
+			$module->profileIn();
+			$module->execute();
+			$module->profileOut();
+		}
+	}
+
+	private function outputGeneralPageInfo() {
+
+		$pageSet = $this->getPageSet();
+
+		// Title normalizations
+		$normValues = array ();
+		foreach ($pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr) {
+			$normValues[] = array (
+				'from' => $rawTitleStr,
+				'to' => $titleStr
+			);
+		}
+
+		if (!empty ($normValues)) {
+			ApiResult :: setIndexedTagName($normValues, 'n');
+			$this->getResult()->addValue('query', 'normalized', $normValues);
+		}
+
+		// Show redirect information
+		$redirValues = array ();
+		foreach ($pageSet->getRedirectTitles() as $titleStrFrom => $titleStrTo) {
+			$redirValues[] = array (
+				'from' => $titleStrFrom,
+				'to' => $titleStrTo
+			);
+		}
+
+		if (!empty ($redirValues)) {
+			ApiResult :: setIndexedTagName($redirValues, 'r');
+			$this->getResult()->addValue('query', 'redirects', $redirValues);
+		}
+
+		//
+		// Page elements
+		//
+		$pages = array ();
+
+		// Report any missing titles
+		$fakepageid = -1;
+		foreach ($pageSet->getMissingTitles() as $title) {
+			$pages[$fakepageid--] = array (
+			'ns' => $title->getNamespace(), 'title' => $title->getPrefixedText(), 'missing' => '');
+		}
+
+		// Report any missing page ids
+		foreach ($pageSet->getMissingPageIDs() as $pageid) {
+			$pages[$pageid] = array (
+				'id' => $pageid,
+				'missing' => ''
+			);
+		}
+
+		// Output general page information for found titles
+		foreach ($pageSet->getGoodTitles() as $pageid => $title) {
+			$pages[$pageid] = array (
+			'ns' => $title->getNamespace(), 'title' => $title->getPrefixedText(), 'id' => $pageid);
+		}
+
+		if (!empty ($pages)) {
+			ApiResult :: setIndexedTagName($pages, 'page');
+			$this->getResult()->addValue('query', 'pages', $pages);
+		}
+	}
+
+	protected function executeGeneratorModule($generatorName, $redirects) {
+
+		// 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");
+		}
+
+		// Use current pageset as the result, and create a new one just for the generator 
+		$resultPageSet = $this->mPageSet;
+		$this->mPageSet = new ApiPageSet($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();
+		$generator->requestExtraData();
+
+		// execute current pageSet to get the data for the generator module
+		$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;
+	}
+
+	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
+		);
+	}
+
+	/**
+	 * Override the parent to generate help messages for all available query modules.
+	 */
+	public function makeHelpMsg() {
+
+		// Use parent to make default message for the query module
+		$msg = parent :: makeHelpMsg();
+
+		// Make sure the internal object is empty
+		// (just in case a sub-module decides to optimize during instantiation)
+		$this->mPageSet = null;
+
+		$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');
+
+		return $msg;
+	}
+
+	private function makeHelpMsgHelper($moduleList, $paramName) {
+
+		$moduleDscriptions = array ();
+
+		foreach ($moduleList as $moduleName => $moduleClass) {
+			$msg = "* $paramName=$moduleName *";
+			$module = new $moduleClass ($this, $moduleName, null);
+			$msg2 = $module->makeHelpMsg();
+			if ($msg2 !== false)
+				$msg .= $msg2;
+			if ($module instanceof ApiQueryGeneratorBase)
+				$msg .= "Generator:\n  This module may be used as a generator\n";
+			$moduleDscriptions[] = $msg;
+		}
+
+		return implode("\n", $moduleDscriptions);
+	}
+
+	/**
+	 * Override to add extra parameters from PageSet
+	 */
+	public function makeHelpMsgParameters() {
+		$psModule = new ApiPageSet($this);
+		return $psModule->makeHelpMsgParameters() . parent :: makeHelpMsgParameters();
+	}
+
+	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'
+		);
+	}
+
+	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 16820 2006-10-06 01:02:14Z yurik $';
+		$vers[] = $psModule->getVersion();
+		return $vers;
+	}
+}
+?>