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 if (!$this->addWhereIf('page_is_redirect = 1', $params['filterredir'] === 'redirects'))
61 $this->addWhereIf('page_is_redirect = 0', $params['filterredir'] === 'nonredirects');
62 $this->addWhereFld('page_namespace', $params['namespace']);
63 if (!is_null($params['from']))
64 $this->addWhere('page_title>=' . $db->addQuotes(ApiQueryBase
:: titleToKey($params['from'])));
65 if (isset ($params['prefix']))
66 $this->addWhere("page_title LIKE '" . $db->escapeLike(ApiQueryBase
:: titleToKey($params['prefix'])) . "%'");
68 $forceNameTitleIndex = true;
69 if (isset ($params['minsize'])) {
70 $this->addWhere('page_len>=' . intval($params['minsize']));
71 $forceNameTitleIndex = false;
74 if (isset ($params['maxsize'])) {
75 $this->addWhere('page_len<=' . intval($params['maxsize']));
76 $forceNameTitleIndex = false;
79 // Page protection filtering
80 if (isset ($params['prtype'])) {
81 $this->addTables('page_restrictions');
82 $this->addWhere('page_id=pr_page');
83 $this->addWhere('pr_expiry>' . $db->addQuotes($db->timestamp()));
84 $this->addWhereFld('pr_type', $params['prtype']);
86 $prlevel = $params['prlevel'];
87 if (!is_null($prlevel) && $prlevel != '' && $prlevel != '*')
88 $this->addWhereFld('pr_level', $prlevel);
90 $forceNameTitleIndex = false;
92 } else if (isset ($params['prlevel'])) {
93 $this->dieUsage('prlevel may not be used without prtype', 'params');
96 $this->addTables('page');
97 if ($forceNameTitleIndex)
98 $this->addOption('USE INDEX', 'name_title');
101 if (is_null($resultPageSet)) {
102 $this->addFields(array (
108 $this->addFields($resultPageSet->getPageTableFields());
111 $limit = $params['limit'];
112 $this->addOption('LIMIT', $limit+
1);
113 $this->addOption('ORDER BY', 'page_namespace, page_title');
115 $res = $this->select(__METHOD__
);
119 while ($row = $db->fetchObject($res)) {
120 if (++
$count > $limit) {
121 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
122 // TODO: Security issue - if the user has no right to view next title, it will still be shown
123 $this->setContinueEnumParameter('from', ApiQueryBase
:: keyToTitle($row->page_title
));
127 if (is_null($resultPageSet)) {
128 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
130 'pageid' => intval($row->page_id
),
131 'ns' => intval($title->getNamespace()),
132 'title' => $title->getPrefixedText());
134 $resultPageSet->processDbRow($row);
137 $db->freeResult($res);
139 if (is_null($resultPageSet)) {
140 $result = $this->getResult();
141 $result->setIndexedTagName($data, 'p');
142 $result->addValue('query', $this->getModuleName(), $data);
146 protected function getAllowedParams() {
147 global $wgRestrictionTypes, $wgRestrictionLevels;
152 'namespace' => array (
153 ApiBase
:: PARAM_DFLT
=> 0,
154 ApiBase
:: PARAM_TYPE
=> 'namespace',
156 'filterredir' => array (
157 ApiBase
:: PARAM_DFLT
=> 'all',
158 ApiBase
:: PARAM_TYPE
=> array (
165 ApiBase
:: PARAM_TYPE
=> 'integer',
168 ApiBase
:: PARAM_TYPE
=> 'integer',
171 ApiBase
:: PARAM_TYPE
=> $wgRestrictionTypes,
174 ApiBase
:: PARAM_TYPE
=> $wgRestrictionLevels,
177 ApiBase
:: PARAM_DFLT
=> 10,
178 ApiBase
:: PARAM_TYPE
=> 'limit',
179 ApiBase
:: PARAM_MIN
=> 1,
180 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
181 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
186 protected function getParamDescription() {
188 'from' => 'The page title to start enumerating from.',
189 'prefix' => 'Search for all page titles that begin with this value.',
190 'namespace' => 'The namespace to enumerate.',
191 'filterredir' => 'Which pages to list.',
192 'minsize' => 'Limit to pages with at least this many bytes',
193 'maxsize' => 'Limit to pages with at most this many bytes',
194 'prtype' => 'Limit to protected pages only',
195 'prlevel' => 'The protection level (must be used with apprtype= parameter)',
196 'limit' => 'How many total pages to return.'
200 protected function getDescription() {
201 return 'Enumerate all pages sequentially in a given namespace';
204 protected function getExamples() {
207 ' Show a list of pages starting at the letter "B"',
208 ' api.php?action=query&list=allpages&apfrom=B',
209 'Using as Generator',
210 ' Show info about 4 pages starting at the letter "T"',
211 ' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
212 ' Show content of first 2 non-redirect pages begining at "Re"',
213 ' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
217 public function getVersion() {
218 return __CLASS__
. ': $Id$';