92c8284360f80975308d4d9565a0f84ffa731b0b
[lhc/web/wiklou.git] / includes / api / ApiQuery.php
1 <?php
2
3
4 /*
5 * Created on Sep 7, 2006
6 *
7 * API for MediaWiki 1.8+
8 *
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
25 */
26
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ('ApiBase.php');
30 }
31
32 class ApiQuery extends ApiBase {
33
34 private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;
35 private $mPageSet;
36
37 private $mQueryPropModules = array (
38 'info' => 'ApiQueryInfo',
39 'revisions' => 'ApiQueryRevisions'
40 );
41 // 'categories' => 'ApiQueryCategories',
42 // 'imageinfo' => 'ApiQueryImageinfo',
43 // 'langlinks' => 'ApiQueryLanglinks',
44 // 'links' => 'ApiQueryLinks',
45 // 'templates' => 'ApiQueryTemplates',
46
47 private $mQueryListModules = array (
48 'allpages' => 'ApiQueryAllpages'
49 );
50 // 'backlinks' => 'ApiQueryBacklinks',
51 // 'categorymembers' => 'ApiQueryCategorymembers',
52 // 'embeddedin' => 'ApiQueryEmbeddedin',
53 // 'imagelinks' => 'ApiQueryImagelinks',
54 // 'logevents' => 'ApiQueryLogevents',
55 // 'recentchanges' => 'ApiQueryRecentchanges',
56 // 'usercontribs' => 'ApiQueryUsercontribs',
57 // 'users' => 'ApiQueryUsers',
58 // 'watchlist' => 'ApiQueryWatchlist',
59
60 private $mQueryMetaModules = array (
61 'siteinfo' => 'ApiQuerySiteinfo'
62 );
63 // 'userinfo' => 'ApiQueryUserinfo',
64
65 private $mSlaveDB = null;
66
67 public function __construct($main, $action) {
68 parent :: __construct($main, $action);
69 $this->mPropModuleNames = array_keys($this->mQueryPropModules);
70 $this->mListModuleNames = array_keys($this->mQueryListModules);
71 $this->mMetaModuleNames = array_keys($this->mQueryMetaModules);
72
73 // Allow the entire list of modules at first,
74 // but during module instantiation check if it can be used as a generator.
75 $this->mAllowedGenerators = array_merge($this->mListModuleNames, $this->mPropModuleNames);
76 }
77
78 public function getDB() {
79 if (!isset ($this->mSlaveDB))
80 $this->mSlaveDB = & wfGetDB(DB_SLAVE);
81 return $this->mSlaveDB;
82 }
83
84 public function getPageSet() {
85 return $this->mPageSet;
86 }
87
88 /**
89 * Query execution happens in the following steps:
90 * #1 Create a PageSet object with any pages requested by the user
91 * #2 If using generator, execute it to get a new PageSet object
92 * #3 Instantiate all requested modules.
93 * This way the PageSet object will know what shared data is required,
94 * and minimize DB calls.
95 * #4 Output all normalization and redirect resolution information
96 * #5 Execute all requested modules
97 */
98 public function execute() {
99 $prop = $list = $meta = $generator = null;
100 extract($this->extractRequestParams());
101
102 //
103 // Create PageSet
104 //
105 $this->mPageSet = new ApiPageSet($this);
106
107 // Instantiate required modules
108 $modules = array ();
109 if (isset ($prop))
110 foreach ($prop as $moduleName)
111 $modules[] = new $this->mQueryPropModules[$moduleName] ($this, $moduleName);
112 if (isset ($list))
113 foreach ($list as $moduleName)
114 $modules[] = new $this->mQueryListModules[$moduleName] ($this, $moduleName);
115 if (isset ($meta))
116 foreach ($meta as $moduleName)
117 $modules[] = new $this->mQueryMetaModules[$moduleName] ($this, $moduleName);
118
119 // Modules may optimize data requests through the $this->getPageSet() object
120 // Execute all requested modules.
121 foreach ($modules as $module) {
122 $module->requestExtraData();
123 }
124
125 //
126 // If given, execute generator to substitute user supplied data with generated data.
127 //
128 if (isset ($generator))
129 $this->executeGenerator($generator);
130
131 //
132 // Populate page information for the given pageSet
133 //
134 $this->mPageSet->execute();
135
136 //
137 // Record page information (title, namespace, if exists, etc)
138 //
139 $this->outputGeneralPageInfo();
140
141 //
142 // Execute all requested modules.
143 //
144 foreach ($modules as $module) {
145 $module->profileIn();
146 $module->execute();
147 $module->profileOut();
148 }
149 }
150
151 private function outputGeneralPageInfo() {
152
153 $pageSet = $this->getPageSet();
154
155 // Title normalizations
156 $normValues = array ();
157 foreach ($pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr) {
158 $normValues[] = array (
159 'from' => $rawTitleStr,
160 'to' => $titleStr
161 );
162 }
163
164 if (!empty ($normValues)) {
165 ApiResult :: setIndexedTagName($normValues, 'n');
166 $this->getResult()->addValue('query', 'normalized', $normValues);
167 }
168
169 // Show redirect information
170 $redirValues = array ();
171 foreach ($pageSet->getRedirectTitles() as $titleStrFrom => $titleStrTo) {
172 $redirValues[] = array (
173 'from' => $titleStrFrom,
174 'to' => $titleStrTo
175 );
176 }
177
178 if (!empty ($redirValues)) {
179 ApiResult :: setIndexedTagName($redirValues, 'r');
180 $this->getResult()->addValue('query', 'redirects', $redirValues);
181 }
182
183 //
184 // Page elements
185 //
186 $pages = array ();
187
188 // Report any missing titles
189 $fakepageid = -1;
190 foreach ($pageSet->getMissingTitles() as $title) {
191 $pages[$fakepageid--] = array (
192 'ns' => $title->getNamespace(), 'title' => $title->getPrefixedText(), 'missing' => '');
193 }
194
195 // Report any missing page ids
196 foreach ($pageSet->getMissingPageIDs() as $pageid) {
197 $pages[$pageid] = array (
198 'id' => $pageid,
199 'missing' => ''
200 );
201 }
202
203 // Output general page information for found titles
204 foreach ($pageSet->getGoodTitles() as $pageid => $title) {
205 $pages[$pageid] = array (
206 'ns' => $title->getNamespace(), 'title' => $title->getPrefixedText(), 'id' => $pageid);
207 }
208
209 if (!empty ($pages)) {
210 ApiResult :: setIndexedTagName($pages, 'page');
211 $this->getResult()->addValue('query', 'pages', $pages);
212 }
213 }
214
215 protected function executeGenerator($generatorName) {
216
217 // Find class that implements requested generator
218 if (isset ($this->mQueryListModules[$generatorName])) {
219 $className = $this->mQueryListModules[$generatorName];
220 }
221 elseif (isset ($this->mQueryPropModules[$generatorName])) {
222 $className = $this->mQueryPropModules[$generatorName];
223 } else {
224 ApiBase :: dieDebug(__METHOD__, "Unknown generator=$generatorName");
225 }
226
227 // Use current pageset as the result, and create a new one just for the generator
228 $resultPageSet = $this->mPageSet;
229 $this->mPageSet = new ApiPageSet($this);
230
231 // Create and execute the generator
232 $generator = new $className ($this, $generatorName);
233 if (!$generator instanceof ApiQueryGeneratorBase)
234 $this->dieUsage("Module $generatorName cannot be used as a generator", "badgenerator");
235
236 $generator->setGeneratorMode();
237 $generator->requestExtraData();
238
239 // execute current pageSet to get the data for the generator module
240 $this->mPageSet->execute();
241
242 // populate resultPageSet with the generator output
243 $generator->profileIn();
244 $generator->executeGenerator($resultPageSet);
245 $generator->profileOut();
246
247 // Swap the resulting pageset back in
248 $this->mPageSet = $resultPageSet;
249 }
250
251 protected function getAllowedParams() {
252 return array (
253 'prop' => array (
254 ApiBase :: PARAM_ISMULTI => true,
255 ApiBase :: PARAM_TYPE => $this->mPropModuleNames
256 ),
257 'list' => array (
258 ApiBase :: PARAM_ISMULTI => true,
259 ApiBase :: PARAM_TYPE => $this->mListModuleNames
260 ),
261 'meta' => array (
262 ApiBase :: PARAM_ISMULTI => true,
263 ApiBase :: PARAM_TYPE => $this->mMetaModuleNames
264 ),
265 'generator' => array (
266 ApiBase :: PARAM_TYPE => $this->mAllowedGenerators
267 )
268 );
269 }
270
271 /**
272 * Override the parent to generate help messages for all available query modules.
273 */
274 public function makeHelpMsg() {
275
276 // Use parent to make default message for the query module
277 $msg = parent :: makeHelpMsg();
278
279 // Make sure the internal object is empty
280 // (just in case a sub-module decides to optimize during instantiation)
281 $this->mPageSet = null;
282
283 $astriks = str_repeat('--- ', 8);
284 $msg .= "\n$astriks Query: Prop $astriks\n\n";
285 $msg .= $this->makeHelpMsgHelper($this->mQueryPropModules, 'prop');
286 $msg .= "\n$astriks Query: List $astriks\n\n";
287 $msg .= $this->makeHelpMsgHelper($this->mQueryListModules, 'list');
288 $msg .= "\n$astriks Query: Meta $astriks\n\n";
289 $msg .= $this->makeHelpMsgHelper($this->mQueryMetaModules, 'meta');
290
291 return $msg;
292 }
293
294 private function makeHelpMsgHelper($moduleList, $paramName) {
295
296 $moduleDscriptions = array ();
297
298 foreach ($moduleList as $moduleName => $moduleClass) {
299 $msg = "* $paramName=$moduleName *";
300 $module = new $moduleClass ($this, $moduleName, null);
301 $msg2 = $module->makeHelpMsg();
302 if ($msg2 !== false)
303 $msg .= $msg2;
304 if ($module instanceof ApiQueryGeneratorBase)
305 $msg .= "Generator:\n This module may be used as a generator\n";
306 $moduleDscriptions[] = $msg;
307 }
308
309 return implode("\n", $moduleDscriptions);
310 }
311
312 /**
313 * Override to add extra parameters from PageSet
314 */
315 public function makeHelpMsgParameters() {
316 $psModule = new ApiPageSet($this);
317 return $psModule->makeHelpMsgParameters() . parent :: makeHelpMsgParameters();
318 }
319
320 protected function getParamDescription() {
321 return array (
322 'prop' => 'Which properties to get for the titles/revisions/pageids',
323 'list' => 'Which lists to get',
324 'meta' => 'Which meta data to get about the site',
325 'generator' => 'Use the output of a list as the input for other prop/list/meta items'
326 );
327 }
328
329 protected function getDescription() {
330 return array (
331 'Query API module allows applications to get needed pieces of data from the MediaWiki databases,',
332 'and is loosely based on the Query API interface currently available on all MediaWiki servers.',
333 'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.'
334 );
335 }
336
337 protected function getExamples() {
338 return array (
339 'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment'
340 );
341 }
342
343 public function getVersion() {
344 $psModule = new ApiPageSet($this);
345 $vers = array ();
346 $vers[] = __CLASS__ . ': $Id$';
347 $vers[] = $psModule->getVersion();
348 return $vers;
349 }
350 }
351 ?>