4 * Created on Oct 16, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ("ApiQueryBase.php");
32 * This is a three-in-one module to query:
33 * * backlinks - links pointing to the given page,
34 * * embeddedin - what pages transclude the given page within themselves,
35 * * imageusage - what pages use the given image
39 class ApiQueryBacklinks
extends ApiQueryGeneratorBase
{
41 private $params, $rootTitle, $contRedirs, $contLevel, $contTitle, $contID, $redirID, $redirect;
42 private $bl_ns, $bl_from, $bl_table, $bl_code, $bl_title, $bl_sort, $bl_fields, $hasNS;
43 private $pageMap, $resultArr;
45 // output element name, database column field prefix, database table
46 private $backlinksSettings = array (
47 'backlinks' => array (
50 'linktbl' => 'pagelinks'
52 'embeddedin' => array (
55 'linktbl' => 'templatelinks'
57 'imageusage' => array (
60 'linktbl' => 'imagelinks'
64 public function __construct($query, $moduleName) {
65 extract($this->backlinksSettings
[$moduleName]);
66 $this->resultArr
= array();
68 parent
:: __construct($query, $moduleName, $code);
69 $this->bl_ns
= $prefix . '_namespace';
70 $this->bl_from
= $prefix . '_from';
71 $this->bl_table
= $linktbl;
72 $this->bl_code
= $code;
74 $this->hasNS
= $moduleName !== 'imageusage';
76 $this->bl_title
= $prefix . '_title';
77 $this->bl_sort
= "{$this->bl_ns}, {$this->bl_title}, {$this->bl_from}";
78 $this->bl_fields
= array (
83 $this->bl_title
= $prefix . '_to';
84 $this->bl_sort
= "{$this->bl_title}, {$this->bl_from}";
85 $this->bl_fields
= array (
91 public function execute() {
95 public function executeGenerator($resultPageSet) {
96 $this->run($resultPageSet);
99 private function prepareFirstQuery($resultPageSet = null) {
100 /* SELECT page_id, page_title, page_namespace, page_is_redirect
101 * FROM pagelinks, page WHERE pl_from=page_id
102 * AND pl_title='Foo' AND pl_namespace=0
103 * LIMIT 11 ORDER BY pl_from
105 $db = $this->getDB();
106 $this->addTables(array('page', $this->bl_table
));
107 $this->addWhere("{$this->bl_from}=page_id");
108 if(is_null($resultPageSet))
109 $this->addFields(array('page_id', 'page_title', 'page_namespace'));
111 $this->addFields($resultPageSet->getPageTableFields());
112 $this->addFields('page_is_redirect');
113 $this->addWhereFld($this->bl_title
, $this->rootTitle
->getDBKey());
115 $this->addWhereFld($this->bl_ns
, $this->rootTitle
->getNamespace());
116 $this->addWhereFld('page_namespace', $this->params
['namespace']);
117 if(!is_null($this->contID
))
118 $this->addWhere("{$this->bl_from}>={$this->contID}");
119 if($this->params
['filterredir'] == 'redirects')
120 $this->addWhereFld('page_is_redirect', 1);
121 if($this->params
['filterredir'] == 'nonredirects')
122 $this->addWhereFld('page_is_redirect', 0);
123 $this->addOption('LIMIT', $this->params
['limit'] +
1);
124 $this->addOption('ORDER BY', $this->bl_from
);
127 private function prepareSecondQuery($resultPageSet = null) {
128 /* SELECT page_id, page_title, page_namespace, page_is_redirect, pl_title, pl_namespace
129 FROM pagelinks, page WHERE pl_from=page_id
130 AND (pl_title='Foo' AND pl_namespace=0) OR (pl_title='Bar' AND pl_namespace=1)
131 ORDER BY pl_namespace, pl_title, pl_from LIMIT 11
133 $db = $this->getDB();
134 $this->addTables(array('page', $this->bl_table
));
135 $this->addWhere("{$this->bl_from}=page_id");
136 if(is_null($resultPageSet))
137 $this->addFields(array('page_id', 'page_title', 'page_namespace', 'page_is_redirect'));
139 $this->addFields($resultPageSet->getPageTableFields());
140 $this->addFields($this->bl_title
);
142 $this->addFields($this->bl_ns
);
143 // We can't use LinkBatch here because $this->hasNS may be false
144 $titleWhere = array();
145 foreach($this->redirTitles
as $t)
146 $titleWhere[] = "{$this->bl_title} = ".$db->addQuotes($t->getDBKey()).
147 ($this->hasNS ?
" AND {$this->bl_ns} = '{$t->getNamespace()}'" : "");
148 $this->addWhere($db->makeList($titleWhere, LIST_OR
));
149 $this->addWhereFld('page_namespace', $this->params
['namespace']);
150 if(!is_null($this->redirID
))
152 $first = $this->redirTitles
[0];
153 $title = $db->strencode($first->getDBKey());
154 $ns = $first->getNamespace();
155 $from = $this->redirID
;
157 $this->addWhere("{$this->bl_ns} > $ns OR ".
158 "({$this->bl_ns} = $ns AND ".
159 "({$this->bl_title} > '$title' OR ".
160 "({$this->bl_title} = '$title' AND ".
161 "{$this->bl_from} >= $from)))");
163 $this->addWhere("{$this->bl_title} > '$title' OR ".
164 "({$this->bl_title} = '$title' AND ".
165 "{$this->bl_from} >= $from)");
168 if($this->params
['filterredir'] == 'redirects')
169 $this->addWhereFld('page_is_redirect', 1);
170 if($this->params
['filterredir'] == 'nonredirects')
171 $this->addWhereFld('page_is_redirect', 0);
172 $this->addOption('LIMIT', $this->params
['limit'] +
1);
173 $this->addOption('ORDER BY', $this->bl_sort
);
174 $this->addOption('USE INDEX', array('page' => 'PRIMARY'));
177 private function run($resultPageSet = null) {
178 $this->params
= $this->extractRequestParams(false);
179 $this->redirect
= isset($this->params
['redirect']) && $this->params
['redirect'];
180 $userMax = ( $this->redirect ? ApiBase
::LIMIT_BIG1
/2 : ApiBase
::LIMIT_BIG1
);
181 $botMax = ( $this->redirect ? ApiBase
::LIMIT_BIG2
/2 : ApiBase
::LIMIT_BIG2
);
182 if( $this->params
['limit'] == 'max' ) {
183 $this->params
['limit'] = $this->getMain()->canApiHighLimits() ?
$botMax : $userMax;
184 $this->getResult()->addValue( 'limits', $this->getModuleName(), $this->params
['limit'] );
187 $this->processContinue();
188 $this->prepareFirstQuery($resultPageSet);
190 $db = $this->getDB();
191 $res = $this->select(__METHOD__
.'::firstQuery');
194 $this->pageMap
= array(); // Maps ns and title to pageid
195 $this->continueStr
= null;
196 $this->redirTitles
= array();
197 while ($row = $db->fetchObject($res)) {
198 if (++
$count > $this->params
['limit']) {
199 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
200 // Continue string preserved in case the redirect query doesn't pass the limit
201 $this->continueStr
= $this->getContinueStr($row->page_id
);
205 if (is_null($resultPageSet))
206 $this->extractRowInfo($row);
209 if($row->page_is_redirect
)
210 $this->redirTitles
[] = Title
::makeTitle($row->page_namespace
, $row->page_title
);
211 $resultPageSet->processDbRow($row);
214 $db->freeResult($res);
216 if($this->redirect
&& count($this->redirTitles
))
218 $this->resetQueryParams();
219 $this->prepareSecondQuery($resultPageSet);
220 $res = $this->select(__METHOD__
.'::secondQuery');
222 while($row = $db->fetchObject($res))
224 if(++
$count > $this->params
['limit'])
226 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
227 // We need to keep the parent page of this redir in
229 $parentID = $this->pageMap
[$row->{$this->bl_ns
}][$row->{$this->bl_title
}];
231 $parentID = $this->pageMap
[NS_IMAGE
][$row->{$this->bl_title
}];
232 $this->continueStr
= $this->getContinueRedirStr($parentID, $row->page_id
);
236 if(is_null($resultPageSet))
237 $this->extractRedirRowInfo($row);
239 $resultPageSet->processDbRow($row);
241 $db->freeResult($res);
243 if (is_null($resultPageSet)) {
244 // Try to add the result data in one go and pray that it fits
245 $fit = $this->getResult()->addValue('query', $this->getModuleName(), array_values($this->resultArr
));
248 // It didn't fit. Add elements one by one until the
250 foreach($this->resultArr
as $pageID => $arr)
252 // Add the basic entry without redirlinks first
253 $fit = $this->getResult()->addValue(
254 array('query', $this->getModuleName()),
255 null, array_diff_key($arr, array('redirlinks' => '')));
258 $this->continueStr
= $this->getContinueStr($pageID);
263 foreach((array)@$arr['redirlinks'] as $key => $redir)
265 $fit = $this->getResult()->addValue(
266 array('query', $this->getModuleName(), $pageID, 'redirlinks'),
270 $this->continueStr
= $this->getContinueRedirStr($pageID, $redir['pageid']);
276 $this->getResult()->setIndexedTagName_internal(
277 array('query', $this->getModuleName(), $pageID, 'redirlinks'),
284 $this->getResult()->setIndexedTagName_internal(
285 array('query', $this->getModuleName()),
288 if(!is_null($this->continueStr
))
289 $this->setContinueEnumParameter('continue', $this->continueStr
);
292 private function extractRowInfo($row) {
293 $this->pageMap
[$row->page_namespace
][$row->page_title
] = $row->page_id
;
294 $t = Title
::makeTitle($row->page_namespace
, $row->page_title
);
295 $a = array('pageid' => intval($row->page_id
));
296 ApiQueryBase
::addTitleInfo($a, $t);
297 if($row->page_is_redirect
)
300 $this->redirTitles
[] = $t;
302 // Put all the results in an array first
303 $this->resultArr
[$a['pageid']] = $a;
306 private function extractRedirRowInfo($row)
308 $a['pageid'] = intval($row->page_id
);
309 ApiQueryBase
::addTitleInfo($a, Title
::makeTitle($row->page_namespace
, $row->page_title
));
310 if($row->page_is_redirect
)
312 $ns = $this->hasNS ?
$row->{$this->bl_ns
} : NS_FILE
;
313 $parentID = $this->pageMap
[$ns][$row->{$this->bl_title
}];
314 // Put all the results in an array first
315 $this->resultArr
[$parentID]['redirlinks'][] = $a;
316 $this->getResult()->setIndexedTagName($this->resultArr
[$parentID]['redirlinks'], $this->bl_code
);
319 protected function processContinue() {
320 if (!is_null($this->params
['continue']))
321 $this->parseContinueParam();
323 if ( $this->params
['title'] !== "" ) {
324 $title = Title
::newFromText( $this->params
['title'] );
326 $this->dieUsageMsg(array('invalidtitle', $this->params
['title']));
328 $this->rootTitle
= $title;
331 $this->dieUsageMsg(array('missingparam', 'title'));
335 // only image titles are allowed for the root in imageinfo mode
336 if (!$this->hasNS
&& $this->rootTitle
->getNamespace() !== NS_FILE
)
337 $this->dieUsage("The title for {$this->getModuleName()} query must be an image", 'bad_image_title');
340 protected function parseContinueParam() {
341 $continueList = explode('|', $this->params
['continue']);
343 // ns | key | id1 [| id2]
344 // ns+key: root title
345 // id1: first-level page ID to continue from
346 // id2: second-level page ID to continue from
348 // null stuff out now so we know what's set and what isn't
349 $this->rootTitle
= $this->contID
= $this->redirID
= null;
350 $rootNs = intval($continueList[0]);
351 if($rootNs === 0 && $continueList[0] !== '0')
352 // Illegal continue parameter
353 $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "_badcontinue");
354 $this->rootTitle
= Title
::makeTitleSafe($rootNs, $continueList[1]);
355 if(!$this->rootTitle
)
356 $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "_badcontinue");
357 $contID = intval($continueList[2]);
358 if($contID === 0 && $continueList[2] !== '0')
359 $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "_badcontinue");
360 $this->contID
= $contID;
361 $redirID = intval(@$continueList[3]);
362 if($redirID === 0 && @$continueList[3] !== '0')
363 // This one isn't required
365 $this->redirID
= $redirID;
369 protected function getContinueStr($lastPageID) {
370 return $this->rootTitle
->getNamespace() .
371 '|' . $this->rootTitle
->getDBkey() .
375 protected function getContinueRedirStr($lastPageID, $lastRedirID) {
376 return $this->getContinueStr($lastPageID) . '|' . $lastRedirID;
379 public function getAllowedParams() {
383 'namespace' => array (
384 ApiBase
:: PARAM_ISMULTI
=> true,
385 ApiBase
:: PARAM_TYPE
=> 'namespace'
387 'filterredir' => array(
388 ApiBase
:: PARAM_DFLT
=> 'all',
389 ApiBase
:: PARAM_TYPE
=> array(
396 ApiBase
:: PARAM_DFLT
=> 10,
397 ApiBase
:: PARAM_TYPE
=> 'limit',
398 ApiBase
:: PARAM_MIN
=> 1,
399 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
400 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
403 if($this->getModuleName() == 'embeddedin')
405 $retval['redirect'] = false;
409 public function getParamDescription() {
411 'title' => 'Title to search. If null, titles= parameter will be used instead, but will be obsolete soon.',
412 'continue' => 'When more results are available, use this to continue.',
413 'namespace' => 'The namespace to enumerate.',
414 'filterredir' => 'How to filter for redirects'
416 if($this->getModuleName() != 'embeddedin')
417 return array_merge($retval, array(
418 'redirect' => 'If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.',
419 'limit' => "How many total pages to return. If {$this->bl_code}redirect is enabled, limit applies to each level separately."
421 return array_merge($retval, array(
422 'limit' => "How many total pages to return."
426 public function getDescription() {
427 switch ($this->getModuleName()) {
429 return 'Find all pages that link to the given page';
431 return 'Find all pages that embed (transclude) the given title';
433 return 'Find all pages that use the given image title.';
435 ApiBase
:: dieDebug(__METHOD__
, 'Unknown module name');
439 protected function getExamples() {
440 static $examples = array (
441 'backlinks' => array (
442 "api.php?action=query&list=backlinks&bltitle=Main%20Page",
443 "api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info"
445 'embeddedin' => array (
446 "api.php?action=query&list=embeddedin&eititle=Template:Stub",
447 "api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info"
449 'imageusage' => array (
450 "api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg",
451 "api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info"
455 return $examples[$this->getModuleName()];
458 public function getVersion() {
459 return __CLASS__
. ': $Id$';