5 * Created on Sep 25, 2006
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
33 * Query module to enumerate all available pages.
37 class ApiQueryAllpages
extends ApiQueryGeneratorBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'ap' );
43 public function execute() {
47 public function getCacheMode( $params ) {
52 * @param $resultPageSet ApiPageSet
55 public function executeGenerator( $resultPageSet ) {
56 if ( $resultPageSet->isResolvingRedirects() ) {
57 $this->dieUsage( 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params' );
60 $this->run( $resultPageSet );
64 * @param $resultPageSet ApiPageSet
67 private function run( $resultPageSet = null ) {
70 $params = $this->extractRequestParams();
73 $this->addTables( 'page' );
75 if ( $params['filterredir'] == 'redirects' ) {
76 $this->addWhereFld( 'page_is_redirect', 1 );
77 } elseif ( $params['filterredir'] == 'nonredirects' ) {
78 $this->addWhereFld( 'page_is_redirect', 0 );
81 $this->addWhereFld( 'page_namespace', $params['namespace'] );
82 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
83 $from = ( is_null( $params['from'] ) ?
null : $this->titlePartToKey( $params['from'] ) );
84 $to = ( is_null( $params['to'] ) ?
null : $this->titlePartToKey( $params['to'] ) );
85 $this->addWhereRange( 'page_title', $dir, $from, $to );
87 if ( isset( $params['prefix'] ) ) {
88 $this->addWhere( 'page_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
91 if ( is_null( $resultPageSet ) ) {
92 $selectFields = array(
98 $selectFields = $resultPageSet->getPageTableFields();
101 $this->addFields( $selectFields );
102 $forceNameTitleIndex = true;
103 if ( isset( $params['minsize'] ) ) {
104 $this->addWhere( 'page_len>=' . intval( $params['minsize'] ) );
105 $forceNameTitleIndex = false;
108 if ( isset( $params['maxsize'] ) ) {
109 $this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) );
110 $forceNameTitleIndex = false;
113 // Page protection filtering
114 if ( count( $params['prtype'] ) ||
$params['prexpiry'] != 'all' ) {
115 $this->addTables( 'page_restrictions' );
116 $this->addWhere( 'page_id=pr_page' );
117 $this->addWhere( 'pr_expiry>' . $db->addQuotes( $db->timestamp() ) );
119 if ( count( $params['prtype'] ) ) {
120 $this->addWhereFld( 'pr_type', $params['prtype'] );
122 if ( isset( $params['prlevel'] ) ) {
123 // Remove the empty string and '*' from the prlevel array
124 $prlevel = array_diff( $params['prlevel'], array( '', '*' ) );
126 if ( count( $prlevel ) ) {
127 $this->addWhereFld( 'pr_level', $prlevel );
130 if ( $params['prfiltercascade'] == 'cascading' ) {
131 $this->addWhereFld( 'pr_cascade', 1 );
132 } elseif ( $params['prfiltercascade'] == 'noncascading' ) {
133 $this->addWhereFld( 'pr_cascade', 0 );
136 $this->addOption( 'DISTINCT' );
138 $forceNameTitleIndex = false;
140 if ( $params['prexpiry'] == 'indefinite' ) {
141 $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" );
142 } elseif ( $params['prexpiry'] == 'definite' ) {
143 $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" );
146 } elseif ( isset( $params['prlevel'] ) ) {
147 $this->dieUsage( 'prlevel may not be used without prtype', 'params' );
150 if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
151 $this->addTables( 'langlinks' );
152 $this->addJoinConds( array( 'langlinks' => array( 'LEFT JOIN', 'page_id=ll_from' ) ) );
153 $this->addWhere( 'll_from IS NULL' );
154 $forceNameTitleIndex = false;
155 } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) {
156 $this->addTables( 'langlinks' );
157 $this->addWhere( 'page_id=ll_from' );
158 $this->addOption( 'STRAIGHT_JOIN' );
159 // We have to GROUP BY all selected fields to stop
160 // PostgreSQL from whining
161 $this->addOption( 'GROUP BY', implode( ', ', $selectFields ) );
162 $forceNameTitleIndex = false;
165 if ( $forceNameTitleIndex ) {
166 $this->addOption( 'USE INDEX', 'name_title' );
169 $limit = $params['limit'];
170 $this->addOption( 'LIMIT', $limit +
1 );
171 $res = $this->select( __METHOD__
);
174 $result = $this->getResult();
175 foreach ( $res as $row ) {
176 if ( ++
$count > $limit ) {
177 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
178 // TODO: Security issue - if the user has no right to view next title, it will still be shown
179 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title
) );
183 if ( is_null( $resultPageSet ) ) {
184 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
186 'pageid' => intval( $row->page_id
),
187 'ns' => intval( $title->getNamespace() ),
188 'title' => $title->getPrefixedText()
190 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
192 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title
) );
196 $resultPageSet->processDbRow( $row );
200 if ( is_null( $resultPageSet ) ) {
201 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' );
205 public function getAllowedParams() {
206 global $wgRestrictionLevels;
212 'namespace' => array(
213 ApiBase
::PARAM_DFLT
=> 0,
214 ApiBase
::PARAM_TYPE
=> 'namespace',
216 'filterredir' => array(
217 ApiBase
::PARAM_DFLT
=> 'all',
218 ApiBase
::PARAM_TYPE
=> array(
225 ApiBase
::PARAM_TYPE
=> 'integer',
228 ApiBase
::PARAM_TYPE
=> 'integer',
231 ApiBase
::PARAM_TYPE
=> Title
::getFilteredRestrictionTypes( true ),
232 ApiBase
::PARAM_ISMULTI
=> true
235 ApiBase
::PARAM_TYPE
=> $wgRestrictionLevels,
236 ApiBase
::PARAM_ISMULTI
=> true
238 'prfiltercascade' => array(
239 ApiBase
::PARAM_DFLT
=> 'all',
240 ApiBase
::PARAM_TYPE
=> array(
247 ApiBase
::PARAM_DFLT
=> 10,
248 ApiBase
::PARAM_TYPE
=> 'limit',
249 ApiBase
::PARAM_MIN
=> 1,
250 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
251 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
254 ApiBase
::PARAM_DFLT
=> 'ascending',
255 ApiBase
::PARAM_TYPE
=> array(
260 'filterlanglinks' => array(
261 ApiBase
::PARAM_TYPE
=> array(
266 ApiBase
::PARAM_DFLT
=> 'all'
269 ApiBase
::PARAM_TYPE
=> array(
274 ApiBase
::PARAM_DFLT
=> 'all'
279 public function getParamDescription() {
280 $p = $this->getModulePrefix();
282 'from' => 'The page title to start enumerating from',
283 'to' => 'The page title to stop enumerating at',
284 'prefix' => 'Search for all page titles that begin with this value',
285 'namespace' => 'The namespace to enumerate',
286 'filterredir' => 'Which pages to list',
287 'dir' => 'The direction in which to list',
288 'minsize' => 'Limit to pages with at least this many bytes',
289 'maxsize' => 'Limit to pages with at most this many bytes',
290 'prtype' => 'Limit to protected pages only',
291 'prlevel' => "The protection level (must be used with {$p}prtype= parameter)",
292 'prfiltercascade' => "Filter protections based on cascadingness (ignored when {$p}prtype isn't set)",
293 'filterlanglinks' => 'Filter based on whether a page has langlinks',
294 'limit' => 'How many total pages to return.',
296 'Which protection expiry to filter the page on',
297 ' indefinite - Get only pages with indefinite protection expiry',
298 ' definite - Get only pages with a definite (specific) protection expiry',
299 ' all - Get pages with any protections expiry'
304 public function getDescription() {
305 return 'Enumerate all pages sequentially in a given namespace';
308 public function getPossibleErrors() {
309 return array_merge( parent
::getPossibleErrors(), array(
310 array( 'code' => 'params', 'info' => 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator' ),
311 array( 'code' => 'params', 'info' => 'prlevel may not be used without prtype' ),
315 protected function getExamples() {
318 ' Show a list of pages starting at the letter "B"',
319 ' api.php?action=query&list=allpages&apfrom=B',
320 'Using as Generator',
321 ' Show info about 4 pages starting at the letter "T"',
322 ' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
323 ' Show content of first 2 non-redirect pages begining at "Re"',
324 ' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
328 public function getHelpUrls() {
329 return 'http://www.mediawiki.org/wiki/API:Allpages';
332 public function getVersion() {
333 return __CLASS__
. ': $Id$';