3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 use MediaWiki\MediaWikiServices
;
25 * Query module to enumerate all available pages.
29 class ApiQueryAllPages
extends ApiQueryGeneratorBase
{
31 public function __construct( ApiQuery
$query, $moduleName ) {
32 parent
::__construct( $query, $moduleName, 'ap' );
35 public function execute() {
39 public function getCacheMode( $params ) {
44 * @param ApiPageSet $resultPageSet
47 public function executeGenerator( $resultPageSet ) {
48 if ( $resultPageSet->isResolvingRedirects() ) {
49 $this->dieWithError( 'apierror-allpages-generator-redirects', 'params' );
52 $this->run( $resultPageSet );
56 * @param ApiPageSet $resultPageSet
59 private function run( $resultPageSet = null ) {
62 $params = $this->extractRequestParams();
65 $this->addTables( 'page' );
67 if ( !is_null( $params['continue'] ) ) {
68 $cont = explode( '|', $params['continue'] );
69 $this->dieContinueUsageIf( count( $cont ) != 1 );
70 $op = $params['dir'] == 'descending' ?
'<' : '>';
71 $cont_from = $db->addQuotes( $cont[0] );
72 $this->addWhere( "page_title $op= $cont_from" );
75 $miserMode = $this->getConfig()->get( 'MiserMode' );
77 if ( $params['filterredir'] == 'redirects' ) {
78 $this->addWhereFld( 'page_is_redirect', 1 );
79 } elseif ( $params['filterredir'] == 'nonredirects' ) {
80 $this->addWhereFld( 'page_is_redirect', 0 );
84 $this->addWhereFld( 'page_namespace', $params['namespace'] );
85 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
86 $from = ( $params['from'] === null
88 : $this->titlePartToKey( $params['from'], $params['namespace'] ) );
89 $to = ( $params['to'] === null
91 : $this->titlePartToKey( $params['to'], $params['namespace'] ) );
92 $this->addWhereRange( 'page_title', $dir, $from, $to );
94 if ( isset( $params['prefix'] ) ) {
95 $this->addWhere( 'page_title' . $db->buildLike(
96 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
100 if ( is_null( $resultPageSet ) ) {
107 $selectFields = $resultPageSet->getPageTableFields();
110 $miserModeFilterRedirValue = null;
111 $miserModeFilterRedir = $miserMode && $params['filterredir'] !== 'all';
112 if ( $miserModeFilterRedir ) {
113 $selectFields[] = 'page_is_redirect';
115 if ( $params['filterredir'] == 'redirects' ) {
116 $miserModeFilterRedirValue = 1;
117 } elseif ( $params['filterredir'] == 'nonredirects' ) {
118 $miserModeFilterRedirValue = 0;
122 $this->addFields( $selectFields );
123 $forceNameTitleIndex = true;
124 if ( isset( $params['minsize'] ) ) {
125 $this->addWhere( 'page_len>=' . intval( $params['minsize'] ) );
126 $forceNameTitleIndex = false;
129 if ( isset( $params['maxsize'] ) ) {
130 $this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) );
131 $forceNameTitleIndex = false;
134 // Page protection filtering
135 if ( $params['prtype'] ||
$params['prexpiry'] != 'all' ) {
136 $this->addTables( 'page_restrictions' );
137 $this->addWhere( 'page_id=pr_page' );
138 $this->addWhere( "pr_expiry > {$db->addQuotes( $db->timestamp() )} OR pr_expiry IS NULL" );
140 if ( $params['prtype'] ) {
141 $this->addWhereFld( 'pr_type', $params['prtype'] );
143 if ( isset( $params['prlevel'] ) ) {
144 // Remove the empty string and '*' from the prlevel array
145 $prlevel = array_diff( $params['prlevel'], [ '', '*' ] );
147 if ( count( $prlevel ) ) {
148 $this->addWhereFld( 'pr_level', $prlevel );
151 if ( $params['prfiltercascade'] == 'cascading' ) {
152 $this->addWhereFld( 'pr_cascade', 1 );
153 } elseif ( $params['prfiltercascade'] == 'noncascading' ) {
154 $this->addWhereFld( 'pr_cascade', 0 );
157 $forceNameTitleIndex = false;
159 if ( $params['prexpiry'] == 'indefinite' ) {
160 $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" );
161 } elseif ( $params['prexpiry'] == 'definite' ) {
162 $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" );
165 $this->addOption( 'DISTINCT' );
166 } elseif ( isset( $params['prlevel'] ) ) {
168 [ 'apierror-invalidparammix-mustusewith', 'prlevel', 'prtype' ], 'invalidparammix'
172 if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
173 $this->addTables( 'langlinks' );
174 $this->addJoinConds( [ 'langlinks' => [ 'LEFT JOIN', 'page_id=ll_from' ] ] );
175 $this->addWhere( 'll_from IS NULL' );
176 $forceNameTitleIndex = false;
177 } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) {
178 $this->addTables( 'langlinks' );
179 $this->addWhere( 'page_id=ll_from' );
180 $this->addOption( 'STRAIGHT_JOIN' );
182 // MySQL filesorts if we use a GROUP BY that works with the rules
183 // in the 1992 SQL standard (it doesn't like having the
184 // constant-in-WHERE page_namespace column in there). Using the
185 // 1999 rules works fine, but that breaks other DBs. Sigh.
186 /// @todo Once we drop support for 1992-rule DBs, we can simplify this.
187 $dbType = $db->getType();
188 if ( $dbType === 'mysql' ||
$dbType === 'sqlite' ) {
189 // Ignore the rules, or 1999 rules if you count unique keys
190 // over non-NULL columns as satisfying the requirement for
191 // "functional dependency" and don't require including
192 // constant-in-WHERE columns in the GROUP BY.
193 $this->addOption( 'GROUP BY', [ 'page_title' ] );
194 } elseif ( $dbType === 'postgres' && $db->getServerVersion() >= 9.1 ) {
195 // 1999 rules only counting primary keys
196 $this->addOption( 'GROUP BY', [ 'page_title', 'page_id' ] );
199 $this->addOption( 'GROUP BY', $selectFields );
202 $forceNameTitleIndex = false;
205 if ( $forceNameTitleIndex ) {
206 $this->addOption( 'USE INDEX', 'name_title' );
209 $limit = $params['limit'];
210 $this->addOption( 'LIMIT', $limit +
1 );
211 $res = $this->select( __METHOD__
);
213 // Get gender information
214 if ( MWNamespace
::hasGenderDistinction( $params['namespace'] ) ) {
216 foreach ( $res as $row ) {
217 $users[] = $row->page_title
;
219 MediaWikiServices
::getInstance()->getGenderCache()->doQuery( $users, __METHOD__
);
220 $res->rewind(); // reset
224 $result = $this->getResult();
225 foreach ( $res as $row ) {
226 if ( ++
$count > $limit ) {
227 // We've reached the one extra which shows that there are
228 // additional pages to be had. Stop here...
229 $this->setContinueEnumParameter( 'continue', $row->page_title
);
233 if ( $miserModeFilterRedir && (int)$row->page_is_redirect
!== $miserModeFilterRedirValue ) {
234 // Filter implemented in PHP due to being in Miser Mode
238 if ( is_null( $resultPageSet ) ) {
239 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
241 'pageid' => intval( $row->page_id
),
242 'ns' => intval( $title->getNamespace() ),
243 'title' => $title->getPrefixedText()
245 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
247 $this->setContinueEnumParameter( 'continue', $row->page_title
);
251 $resultPageSet->processDbRow( $row );
255 if ( is_null( $resultPageSet ) ) {
256 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'p' );
260 public function getAllowedParams() {
264 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
269 ApiBase
::PARAM_DFLT
=> NS_MAIN
,
270 ApiBase
::PARAM_TYPE
=> 'namespace',
273 ApiBase
::PARAM_DFLT
=> 'all',
274 ApiBase
::PARAM_TYPE
=> [
281 ApiBase
::PARAM_TYPE
=> 'integer',
284 ApiBase
::PARAM_TYPE
=> 'integer',
287 ApiBase
::PARAM_TYPE
=> Title
::getFilteredRestrictionTypes( true ),
288 ApiBase
::PARAM_ISMULTI
=> true
291 ApiBase
::PARAM_TYPE
=> $this->getConfig()->get( 'RestrictionLevels' ),
292 ApiBase
::PARAM_ISMULTI
=> true
294 'prfiltercascade' => [
295 ApiBase
::PARAM_DFLT
=> 'all',
296 ApiBase
::PARAM_TYPE
=> [
303 ApiBase
::PARAM_DFLT
=> 10,
304 ApiBase
::PARAM_TYPE
=> 'limit',
305 ApiBase
::PARAM_MIN
=> 1,
306 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
307 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
310 ApiBase
::PARAM_DFLT
=> 'ascending',
311 ApiBase
::PARAM_TYPE
=> [
316 'filterlanglinks' => [
317 ApiBase
::PARAM_TYPE
=> [
322 ApiBase
::PARAM_DFLT
=> 'all'
325 ApiBase
::PARAM_TYPE
=> [
330 ApiBase
::PARAM_DFLT
=> 'all'
334 if ( $this->getConfig()->get( 'MiserMode' ) ) {
335 $ret['filterredir'][ApiBase
::PARAM_HELP_MSG_APPEND
] = [ 'api-help-param-limited-in-miser-mode' ];
341 protected function getExamplesMessages() {
343 'action=query&list=allpages&apfrom=B'
344 => 'apihelp-query+allpages-example-B',
345 'action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info'
346 => 'apihelp-query+allpages-example-generator',
347 'action=query&generator=allpages&gaplimit=2&' .
348 'gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
349 => 'apihelp-query+allpages-example-generator-revisions',
353 public function getHelpUrls() {
354 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages';