-<?php\r
-\r
-\r
-/*\r
- * Created on Sep 7, 2006\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ("ApiBase.php");\r
-}\r
-\r
-class ApiQuery extends ApiBase {\r
-\r
- var $mMetaModuleNames, $mPropModuleNames, $mListModuleNames;\r
-\r
- private $mQueryMetaModules = array (\r
-// 'siteinfo' => 'ApiQuerySiteinfo',\r
-// 'userinfo' => 'ApiQueryUserinfo'\r
- );\r
- private $mQueryPropModules = array (\r
-// 'info' => 'ApiQueryInfo',\r
-// 'categories' => 'ApiQueryCategories',\r
-// 'imageinfo' => 'ApiQueryImageinfo',\r
-// 'langlinks' => 'ApiQueryLanglinks',\r
-// 'links' => 'ApiQueryLinks',\r
-// 'templates' => 'ApiQueryTemplates',\r
-// 'revisions' => 'ApiQueryRevisions',\r
-\r
- // Should be removed\r
- 'content' => 'ApiQueryContent'\r
- );\r
- private $mQueryListModules = array (\r
-// 'allpages' => 'ApiQueryAllpages',\r
-// 'backlinks' => 'ApiQueryBacklinks',\r
-// 'categorymembers' => 'ApiQueryCategorymembers',\r
-// 'embeddedin' => 'ApiQueryEmbeddedin',\r
-// 'imagelinks' => 'ApiQueryImagelinks',\r
-// 'logevents' => 'ApiQueryLogevents',\r
-// 'recentchanges' => 'ApiQueryRecentchanges',\r
-// 'usercontribs' => 'ApiQueryUsercontribs',\r
-// 'users' => 'ApiQueryUsers',\r
-// 'watchlist' => 'ApiQueryWatchlist',\r
- );\r
-\r
- private $mSlaveDB = null;\r
-\r
- public function __construct($main, $action) {\r
- parent :: __construct($main);\r
- $this->mMetaModuleNames = array_keys($this->mQueryMetaModules);\r
- $this->mPropModuleNames = array_keys($this->mQueryPropModules);\r
- $this->mListModuleNames = array_keys($this->mQueryListModules);\r
- \r
- $this->mAllowedGenerators = array_merge( $this->mListModuleNames, $this->mPropModuleNames);\r
- }\r
-\r
- public function GetDB() {\r
- if (!isset ($this->mSlaveDB))\r
- $this->mSlaveDB = & wfGetDB(DB_SLAVE);\r
- return $this->mSlaveDB;\r
- }\r
-\r
- public function Execute() {\r
- $meta = $prop = $list = $generator = $titles = $pageids = $revids = null;\r
- $redirects = null;\r
- extract($this->ExtractRequestParams());\r
-\r
- //\r
- // Only one of the titles/pageids/revids is allowed at the same time\r
- //\r
- $dataSource = null;\r
- if (isset($titles))\r
- $dataSource = 'titles';\r
- if (isset($pageids)) {\r
- if (isset($dataSource))\r
- $this->DieUsage("Cannot use 'pageids' at the same time as '$dataSource'", 'multisource');\r
- $dataSource = 'pageids';\r
- }\r
- if (isset($revids)) {\r
- if (isset($dataSource))\r
- $this->DieUsage("Cannot use 'revids' at the same time as '$dataSource'", 'multisource');\r
- $dataSource = 'revids';\r
- }\r
- \r
- //\r
- // Normalize titles\r
- //\r
- if ($dataSource === 'titles') {\r
- $linkBatch = new LinkBatch;\r
- foreach ( $titles as &$titleString ) {\r
- $titleObj = &Title::newFromText( $titleString );\r
-\r
- // Validation\r
- if (!$titleObj)\r
- $this->dieUsage( "bad title $titleString", 'pi_invalidtitle' );\r
- if ($titleObj->getNamespace() < 0)\r
- $this->dieUsage( "No support for special page $titleString has been implemented", 'pi_unsupportednamespace' );\r
- if (!$titleObj->userCanRead())\r
- $this->dieUsage( "No read permission for $titleString", 'pi_titleaccessdenied' );\r
-\r
- $linkBatch->addObj( $titleObj );\r
-\r
- // Make sure we remember the original title that was given to us\r
- // This way the caller can correlate new titles with the originally requested, i.e. namespace is localized or capitalization\r
- if( $titleString !== $titleObj->getPrefixedText() ) {\r
- $this->GetResult()->AddMessage('query', 'normalized', array($titleString => $titleObj->getPrefixedText()));\r
- }\r
- }\r
- }\r
- }\r
-\r
- protected function GetAllowedParams() {\r
- return array (\r
- 'meta' => array (\r
- GN_ENUM_ISMULTI => true,\r
- GN_ENUM_CHOICES => $this->mMetaModuleNames\r
- ),\r
- 'prop' => array (\r
- GN_ENUM_ISMULTI => true,\r
- GN_ENUM_CHOICES => $this->mPropModuleNames\r
- ),\r
- 'list' => array (\r
- GN_ENUM_ISMULTI => true,\r
- GN_ENUM_CHOICES => $this->mListModuleNames\r
- ),\r
- 'generator' => array (\r
- GN_ENUM_CHOICES => $this->mAllowedGenerators\r
- ),\r
- 'titles' => array (\r
- GN_ENUM_ISMULTI => true\r
- ),\r
- 'pageids' => array (\r
- GN_ENUM_TYPE => 'integer',\r
- GN_ENUM_ISMULTI => true\r
- ),\r
- 'revids' => array (\r
- GN_ENUM_TYPE => 'integer',\r
- GN_ENUM_ISMULTI => true\r
- )\r
- );\r
- }\r
-\r
- protected function GetParamDescription() {\r
- return array (\r
- 'meta' => 'Which meta data to get about the site',\r
- 'prop' => 'Which properties to get for the titles/revisions/pageids',\r
- 'list' => 'Which lists to get',\r
- 'generator' => 'Use the output of a list as the input for other prop/list/meta items',\r
- 'titles' => 'A list of titles to work on',\r
- 'pageids' => 'A list of page IDs to work on',\r
- 'revids' => 'A list of revision IDs to work on'\r
- );\r
- }\r
-\r
- protected function GetDescription() {\r
- return array(\r
- 'Query API module allows applications to get needed pieces of data from the MediaWiki databases,',\r
- 'and is loosely based on the Query API interface currently available on all MediaWiki servers.',\r
- 'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.');\r
- }\r
-\r
- protected function GetExamples() {\r
- return array (\r
- 'api.php ? action=query & what=content & titles=ArticleA|ArticleB'\r
- );\r
- }\r
-}\r
-?>
\ No newline at end of file
+<?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);
+ $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 = null;
+ extract($this->extractRequestParams());
+
+ //
+ // Create PageSet
+ //
+ $this->mPageSet = new ApiPageSet($this);
+
+ //
+ // If generator is provided, get a new dataset to work on
+ //
+ if (isset ($generator))
+ $this->executeGenerator($generator);
+
+ // 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();
+ }
+
+ //
+ // Get page information for the given pageSet
+ //
+ $this->mPageSet->profileIn();
+ $this->mPageSet->execute();
+ $this->mPageSet->profileOut();
+
+ //
+ // Record page information
+ //
+ $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 executeGenerator($generator) {
+
+ // Find class that implements requested generator
+ if (isset ($this->mQueryListModules[$generator]))
+ $className = $this->mQueryListModules[$generator];
+ elseif (isset ($this->mQueryPropModules[$generator])) $className = $this->mQueryPropModules[$generator];
+ else
+ ApiBase :: dieDebug(__METHOD__, "Unknown generator=$generator");
+
+ $module = new $className ($this, $generator, true);
+ $module->requestExtraData();
+
+ // execute pageSet here to get the data required by the generator module
+ $this->mPageSet->profileIn();
+ $this->mPageSet->execute();
+ $this->mPageSet->profileOut();
+
+ // change $this->mPageSet
+
+ // TODO: implement
+ $this->dieUsage('Generator execution has not been implemented', 'notimplemented');
+ }
+
+ 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
+ // ),
+
+
+ );
+ }
+
+ /**
+ * 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->getCanGenerate())
+ $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'
+ );
+ }
+
+ 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 = $psModule->getVersion();
+ $vers[] = __CLASS__ . ': $Id$';
+ return $vers;
+ }
+}
+?>
dépôts / lhc / web / wiklou.git / blobdiff