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();
59 $this->addTables('page');
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 if (is_null($resultPageSet)) {
69 $this->addFields(array (
75 $this->addFields($resultPageSet->getPageTableFields());
78 $this->addOption('USE INDEX', 'name_title');
79 $limit = $params['limit'];
80 $this->addOption('LIMIT', $limit+
1);
81 $this->addOption('ORDER BY', 'page_namespace, page_title');
83 $res = $this->select(__METHOD__
);
87 while ($row = $db->fetchObject($res)) {
88 if (++
$count > $limit) {
89 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
90 // TODO: Security issue - if the user has no right to view next title, it will still be shown
91 $this->setContinueEnumParameter('from', ApiQueryBase
:: keyToTitle($row->page_title
));
95 if (is_null($resultPageSet)) {
96 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
98 'pageid' => intval($row->page_id
),
99 'ns' => intval($title->getNamespace()),
100 'title' => $title->getPrefixedText());
102 $resultPageSet->processDbRow($row);
105 $db->freeResult($res);
107 if (is_null($resultPageSet)) {
108 $result = $this->getResult();
109 $result->setIndexedTagName($data, 'p');
110 $result->addValue('query', $this->getModuleName(), $data);
114 protected function getAllowedParams() {
118 'namespace' => array (
119 ApiBase
:: PARAM_DFLT
=> 0,
120 ApiBase
:: PARAM_TYPE
=> 'namespace'
122 'filterredir' => array (
123 ApiBase
:: PARAM_DFLT
=> 'all',
124 ApiBase
:: PARAM_TYPE
=> array (
131 ApiBase
:: PARAM_DFLT
=> 10,
132 ApiBase
:: PARAM_TYPE
=> 'limit',
133 ApiBase
:: PARAM_MIN
=> 1,
134 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
135 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
140 protected function getParamDescription() {
142 'from' => 'The page title to start enumerating from.',
143 'prefix' => 'Search for all page titles that begin with this value.',
144 'namespace' => 'The namespace to enumerate.',
145 'filterredir' => 'Which pages to list.',
146 'limit' => 'How many total pages to return.'
150 protected function getDescription() {
151 return 'Enumerate all pages sequentially in a given namespace';
154 protected function getExamples() {
157 ' Show a list of pages starting at the letter "B"',
158 ' api.php?action=query&list=allpages&apfrom=B',
159 'Using as Generator',
160 ' Show info about 4 pages starting at the letter "T"',
161 ' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
162 ' Show content of first 2 non-redirect pages begining at "Re"',
163 ' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
167 public function getVersion() {
168 return __CLASS__
. ': $Id$';