4 * Created on Sep 25, 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 * Query module to enumerate all available pages.
36 class ApiQueryAllpages
extends ApiQueryGeneratorBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'ap');
42 public function execute() {
46 public function executeGenerator($resultPageSet) {
47 if ($resultPageSet->isResolvingRedirects())
48 $this->dieUsage('Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params');
50 $this->run($resultPageSet);
53 private function run($resultPageSet = null) {
57 $params = $this->extractRequestParams();
60 $this->addTables('page');
61 if (!$this->addWhereIf('page_is_redirect = 1', $params['filterredir'] === 'redirects'))
62 $this->addWhereIf('page_is_redirect = 0', $params['filterredir'] === 'nonredirects');
63 $this->addWhereFld('page_namespace', $params['namespace']);
64 $dir = ($params['dir'] == 'descending' ?
'older' : 'newer');
65 $from = (is_null($params['from']) ?
null : $this->titlePartToKey($params['from']));
66 $this->addWhereRange('page_title', $dir, $from, null);
67 if (isset ($params['prefix']))
68 $this->addWhere("page_title LIKE '" . $db->escapeLike($this->titlePartToKey($params['prefix'])) . "%'");
70 $forceNameTitleIndex = true;
71 if (isset ($params['minsize'])) {
72 $this->addWhere('page_len>=' . intval($params['minsize']));
73 $forceNameTitleIndex = false;
76 if (isset ($params['maxsize'])) {
77 $this->addWhere('page_len<=' . intval($params['maxsize']));
78 $forceNameTitleIndex = false;
81 // Page protection filtering
82 if (!empty ($params['prtype'])) {
83 $this->addTables('page_restrictions');
84 $this->addWhere('page_id=pr_page');
85 $this->addWhere('pr_expiry>' . $db->addQuotes($db->timestamp()));
86 $this->addWhereFld('pr_type', $params['prtype']);
88 // Remove the empty string and '*' from the prlevel array
89 $prlevel = array_diff($params['prlevel'], array('', '*'));
91 $this->addWhereFld('pr_level', $prlevel);
93 $this->addOption('DISTINCT');
95 $forceNameTitleIndex = false;
97 } else if (isset ($params['prlevel'])) {
98 $this->dieUsage('prlevel may not be used without prtype', 'params');
101 if($params['filterlanglinks'] == 'withoutlanglinks') {
102 $this->addTables('langlinks');
103 $this->addJoinConds(array('langlinks' => array('LEFT JOIN', 'page_id=ll_from')));
104 $this->addWhere('ll_from IS NULL');
105 $forceNameTitleIndex = false;
106 } else if($params['filterlanglinks'] == 'withlanglinks') {
107 $this->addTables('langlinks');
108 $this->addWhere('page_id=ll_from');
109 $this->addOption('DISTINCT');
110 $forceNameTitleIndex = false;
112 if ($forceNameTitleIndex)
113 $this->addOption('USE INDEX', 'name_title');
115 if (is_null($resultPageSet)) {
116 $this->addFields(array (
122 $this->addFields($resultPageSet->getPageTableFields());
125 $limit = $params['limit'];
126 $this->addOption('LIMIT', $limit+
1);
127 $res = $this->select(__METHOD__
);
131 while ($row = $db->fetchObject($res)) {
132 if (++
$count > $limit) {
133 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
134 // TODO: Security issue - if the user has no right to view next title, it will still be shown
135 $this->setContinueEnumParameter('from', $this->keyToTitle($row->page_title
));
139 if (is_null($resultPageSet)) {
140 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
142 'pageid' => intval($row->page_id
),
143 'ns' => intval($title->getNamespace()),
144 'title' => $title->getPrefixedText());
146 $resultPageSet->processDbRow($row);
149 $db->freeResult($res);
151 if (is_null($resultPageSet)) {
152 $result = $this->getResult();
153 $result->setIndexedTagName($data, 'p');
154 $result->addValue('query', $this->getModuleName(), $data);
158 public function getAllowedParams() {
159 global $wgRestrictionTypes, $wgRestrictionLevels;
164 'namespace' => array (
165 ApiBase
:: PARAM_DFLT
=> 0,
166 ApiBase
:: PARAM_TYPE
=> 'namespace',
168 'filterredir' => array (
169 ApiBase
:: PARAM_DFLT
=> 'all',
170 ApiBase
:: PARAM_TYPE
=> array (
177 ApiBase
:: PARAM_TYPE
=> 'integer',
180 ApiBase
:: PARAM_TYPE
=> 'integer',
183 ApiBase
:: PARAM_TYPE
=> $wgRestrictionTypes,
184 ApiBase
:: PARAM_ISMULTI
=> true
187 ApiBase
:: PARAM_TYPE
=> $wgRestrictionLevels,
188 ApiBase
:: PARAM_ISMULTI
=> true
191 ApiBase
:: PARAM_DFLT
=> 10,
192 ApiBase
:: PARAM_TYPE
=> 'limit',
193 ApiBase
:: PARAM_MIN
=> 1,
194 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
195 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
198 ApiBase
:: PARAM_DFLT
=> 'ascending',
199 ApiBase
:: PARAM_TYPE
=> array (
204 'filterlanglinks' => array(
205 ApiBase
:: PARAM_TYPE
=> array(
210 ApiBase
:: PARAM_DFLT
=> 'all'
215 public function getParamDescription() {
217 'from' => 'The page title to start enumerating from.',
218 'prefix' => 'Search for all page titles that begin with this value.',
219 'namespace' => 'The namespace to enumerate.',
220 'filterredir' => 'Which pages to list.',
221 'dir' => 'The direction in which to list',
222 'minsize' => 'Limit to pages with at least this many bytes',
223 'maxsize' => 'Limit to pages with at most this many bytes',
224 'prtype' => 'Limit to protected pages only',
225 'prlevel' => 'The protection level (must be used with apprtype= parameter)',
226 'filterlanglinks' => 'Filter based on whether a page has langlinks',
227 'limit' => 'How many total pages to return.'
231 public function getDescription() {
232 return 'Enumerate all pages sequentially in a given namespace';
235 protected function getExamples() {
238 ' Show a list of pages starting at the letter "B"',
239 ' api.php?action=query&list=allpages&apfrom=B',
240 'Using as Generator',
241 ' Show info about 4 pages starting at the letter "T"',
242 ' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
243 ' Show content of first 2 non-redirect pages begining at "Re"',
244 ' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
248 public function getVersion() {
249 return __CLASS__
. ': $Id$';