5 * Created on Sep 25, 2006
7 * API for MediaWiki 1.8+
9 * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
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.
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.
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
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ('ApiQueryBase.php');
32 class ApiQueryAllpages
extends ApiQueryGeneratorBase
{
34 public function __construct($query, $moduleName) {
35 parent
:: __construct($query, $moduleName, 'ap');
38 public function execute() {
42 public function executeGenerator($resultPageSet) {
43 if ($resultPageSet->isResolvingRedirects())
44 $this->dieUsage('Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params');
46 $this->run($resultPageSet);
49 private function run($resultPageSet = null) {
51 wfProfileIn($this->getModuleProfileName() . '-getDB');
52 $db = & $this->getDB();
53 wfProfileOut($this->getModuleProfileName() . '-getDB');
55 wfProfileIn($this->getModuleProfileName() . '-parseParams');
56 $limit = $from = $namespace = $filterredir = $prefix = null;
57 extract($this->extractRequestParams());
59 $this->addTables('page');
60 if (!$this->addWhereIf('page_is_redirect = 1', $filterredir === 'redirects'))
61 $this->addWhereIf('page_is_redirect = 0', $filterredir === 'nonredirects');
62 $this->addWhereFld('page_namespace', $namespace);
64 $this->addWhere('page_title>=' . $db->addQuotes(ApiQueryBase
:: titleToKey($from)));
66 $this->addWhere("page_title LIKE '{$db->strencode(ApiQueryBase :: titleToKey($prefix))}%'");
68 if (is_null($resultPageSet)) {
69 $this->addFields(array (
75 $this->addFields($resultPageSet->getPageTableFields());
78 $this->addOption('USE INDEX', 'name_title');
79 $this->addOption('LIMIT', $limit +
1);
80 $this->addOption('ORDER BY', 'page_namespace, page_title');
82 wfProfileOut($this->getModuleProfileName() . '-parseParams');
84 $res = $this->select(__METHOD__
);
86 wfProfileIn($this->getModuleProfileName() . '-saveResults');
90 while ($row = $db->fetchObject($res)) {
91 if (++
$count > $limit) {
92 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
93 $this->setContinueEnumParameter('from', ApiQueryBase
:: keyToTitle($row->page_title
));
97 if (is_null($resultPageSet)) {
98 $vals = $this->addRowInfo('page', $row);
100 $data[intval($row->page_id
)] = $vals;
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);
113 wfProfileOut($this->getModuleProfileName() . '-saveResults');
116 protected function getAllowedParams() {
120 'namespace' => array (
121 ApiBase
:: PARAM_DFLT
=> 0,
122 ApiBase
:: PARAM_TYPE
=> 'namespace'
124 'filterredir' => array (
125 ApiBase
:: PARAM_DFLT
=> 'all',
126 ApiBase
:: PARAM_TYPE
=> array (
133 ApiBase
:: PARAM_DFLT
=> 10,
134 ApiBase
:: PARAM_TYPE
=> 'limit',
135 ApiBase
:: PARAM_MIN
=> 1,
136 ApiBase
:: PARAM_MAX1
=> ApiBase
:: LIMIT_BIG1
,
137 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
142 protected function getParamDescription() {
144 'from' => 'The page title to start enumerating from.',
145 'prefix' => 'Search for all page titles that begin with this value.',
146 'namespace' => 'The namespace to enumerate.',
147 'filterredir' => 'Which pages to list.',
148 'limit' => 'How many total pages to return.'
152 protected function getDescription() {
153 return 'Enumerate all pages sequentially in a given namespace';
156 protected function getExamples() {
159 ' Show a list of pages starting at the letter "B"',
160 ' api.php?action=query&list=allpages&apfrom=B',
161 'Using as Generator',
162 ' Show info about 4 pages starting at the letter "T"',
163 ' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
164 ' Show content of first 2 non-redirect pages begining at "Re"',
165 ' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
169 public function getVersion() {
170 return __CLASS__
. ': $Id$';