includes/api/ApiQueryAllPages.php

   1 <?php
   2 /**
   3  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22 use MediaWiki\MediaWikiServices;
  23
  24 /**
  25  * Query module to enumerate all available pages.
  26  *
  27  * @ingroup API
  28  */
  29 class ApiQueryAllPages extends ApiQueryGeneratorBase {
  30
  31         public function __construct( ApiQuery $query, $moduleName ) {
  32                 parent::__construct( $query, $moduleName, 'ap' );
  33         }
  34
  35         public function execute() {
  36                 $this->run();
  37         }
  38
  39         public function getCacheMode( $params ) {
  40                 return 'public';
  41         }
  42
  43         /**
  44          * @param ApiPageSet $resultPageSet
  45          * @return void
  46          */
  47         public function executeGenerator( $resultPageSet ) {
  48                 if ( $resultPageSet->isResolvingRedirects() ) {
  49                         $this->dieWithError( 'apierror-allpages-generator-redirects', 'params' );
  50                 }
  51
  52                 $this->run( $resultPageSet );
  53         }
  54
  55         /**
  56          * @param ApiPageSet $resultPageSet
  57          * @return void
  58          */
  59         private function run( $resultPageSet = null ) {
  60                 $db = $this->getDB();
  61
  62                 $params = $this->extractRequestParams();
  63
  64                 // Page filters
  65                 $this->addTables( 'page' );
  66
  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" );
  73                 }
  74
  75                 $miserMode = $this->getConfig()->get( 'MiserMode' );
  76                 if ( !$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 );
  81                         }
  82                 }
  83
  84                 $this->addWhereFld( 'page_namespace', $params['namespace'] );
  85                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  86                 $from = ( $params['from'] === null
  87                         ? null
  88                         : $this->titlePartToKey( $params['from'], $params['namespace'] ) );
  89                 $to = ( $params['to'] === null
  90                         ? null
  91                         : $this->titlePartToKey( $params['to'], $params['namespace'] ) );
  92                 $this->addWhereRange( 'page_title', $dir, $from, $to );
  93
  94                 if ( isset( $params['prefix'] ) ) {
  95                         $this->addWhere( 'page_title' . $db->buildLike(
  96                                 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
  97                                 $db->anyString() ) );
  98                 }
  99
 100                 if ( is_null( $resultPageSet ) ) {
 101                         $selectFields = [
 102                                 'page_namespace',
 103                                 'page_title',
 104                                 'page_id'
 105                         ];
 106                 } else {
 107                         $selectFields = $resultPageSet->getPageTableFields();
 108                 }
 109
 110                 $miserModeFilterRedirValue = null;
 111                 $miserModeFilterRedir = $miserMode && $params['filterredir'] !== 'all';
 112                 if ( $miserModeFilterRedir ) {
 113                         $selectFields[] = 'page_is_redirect';
 114
 115                         if ( $params['filterredir'] == 'redirects' ) {
 116                                 $miserModeFilterRedirValue = 1;
 117                         } elseif ( $params['filterredir'] == 'nonredirects' ) {
 118                                 $miserModeFilterRedirValue = 0;
 119                         }
 120                 }
 121
 122                 $this->addFields( $selectFields );
 123                 $forceNameTitleIndex = true;
 124                 if ( isset( $params['minsize'] ) ) {
 125                         $this->addWhere( 'page_len>=' . (int)$params['minsize'] );
 126                         $forceNameTitleIndex = false;
 127                 }
 128
 129                 if ( isset( $params['maxsize'] ) ) {
 130                         $this->addWhere( 'page_len<=' . (int)$params['maxsize'] );
 131                         $forceNameTitleIndex = false;
 132                 }
 133
 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" );
 139
 140                         if ( $params['prtype'] ) {
 141                                 $this->addWhereFld( 'pr_type', $params['prtype'] );
 142
 143                                 if ( isset( $params['prlevel'] ) ) {
 144                                         // Remove the empty string and '*' from the prlevel array
 145                                         $prlevel = array_diff( $params['prlevel'], [ '', '*' ] );
 146
 147                                         if ( count( $prlevel ) ) {
 148                                                 $this->addWhereFld( 'pr_level', $prlevel );
 149                                         }
 150                                 }
 151                                 if ( $params['prfiltercascade'] == 'cascading' ) {
 152                                         $this->addWhereFld( 'pr_cascade', 1 );
 153                                 } elseif ( $params['prfiltercascade'] == 'noncascading' ) {
 154                                         $this->addWhereFld( 'pr_cascade', 0 );
 155                                 }
 156                         }
 157                         $forceNameTitleIndex = false;
 158
 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() )}" );
 163                         }
 164
 165                         $this->addOption( 'DISTINCT' );
 166                 } elseif ( isset( $params['prlevel'] ) ) {
 167                         $this->dieWithError(
 168                                 [ 'apierror-invalidparammix-mustusewith', 'prlevel', 'prtype' ], 'invalidparammix'
 169                         );
 170                 }
 171
 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' );
 181
 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' ] );
 197                         } else {
 198                                 // 1992 rules
 199                                 $this->addOption( 'GROUP BY', $selectFields );
 200                         }
 201
 202                         $forceNameTitleIndex = false;
 203                 }
 204
 205                 if ( $forceNameTitleIndex ) {
 206                         $this->addOption( 'USE INDEX', 'name_title' );
 207                 }
 208
 209                 $limit = $params['limit'];
 210                 $this->addOption( 'LIMIT', $limit + 1 );
 211                 $res = $this->select( __METHOD__ );
 212
 213                 // Get gender information
 214                 if ( MWNamespace::hasGenderDistinction( $params['namespace'] ) ) {
 215                         $users = [];
 216                         foreach ( $res as $row ) {
 217                                 $users[] = $row->page_title;
 218                         }
 219                         MediaWikiServices::getInstance()->getGenderCache()->doQuery( $users, __METHOD__ );
 220                         $res->rewind(); // reset
 221                 }
 222
 223                 $count = 0;
 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 );
 230                                 break;
 231                         }
 232
 233                         if ( $miserModeFilterRedir && (int)$row->page_is_redirect !== $miserModeFilterRedirValue ) {
 234                                 // Filter implemented in PHP due to being in Miser Mode
 235                                 continue;
 236                         }
 237
 238                         if ( is_null( $resultPageSet ) ) {
 239                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 240                                 $vals = [
 241                                         'pageid' => (int)$row->page_id,
 242                                         'ns' => (int)$title->getNamespace(),
 243                                         'title' => $title->getPrefixedText()
 244                                 ];
 245                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 246                                 if ( !$fit ) {
 247                                         $this->setContinueEnumParameter( 'continue', $row->page_title );
 248                                         break;
 249                                 }
 250                         } else {
 251                                 $resultPageSet->processDbRow( $row );
 252                         }
 253                 }
 254
 255                 if ( is_null( $resultPageSet ) ) {
 256                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'p' );
 257                 }
 258         }
 259
 260         public function getAllowedParams() {
 261                 $ret = [
 262                         'from' => null,
 263                         'continue' => [
 264                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 265                         ],
 266                         'to' => null,
 267                         'prefix' => null,
 268                         'namespace' => [
 269                                 ApiBase::PARAM_DFLT => NS_MAIN,
 270                                 ApiBase::PARAM_TYPE => 'namespace',
 271                         ],
 272                         'filterredir' => [
 273                                 ApiBase::PARAM_DFLT => 'all',
 274                                 ApiBase::PARAM_TYPE => [
 275                                         'all',
 276                                         'redirects',
 277                                         'nonredirects'
 278                                 ]
 279                         ],
 280                         'minsize' => [
 281                                 ApiBase::PARAM_TYPE => 'integer',
 282                         ],
 283                         'maxsize' => [
 284                                 ApiBase::PARAM_TYPE => 'integer',
 285                         ],
 286                         'prtype' => [
 287                                 ApiBase::PARAM_TYPE => Title::getFilteredRestrictionTypes( true ),
 288                                 ApiBase::PARAM_ISMULTI => true
 289                         ],
 290                         'prlevel' => [
 291                                 ApiBase::PARAM_TYPE => $this->getConfig()->get( 'RestrictionLevels' ),
 292                                 ApiBase::PARAM_ISMULTI => true
 293                         ],
 294                         'prfiltercascade' => [
 295                                 ApiBase::PARAM_DFLT => 'all',
 296                                 ApiBase::PARAM_TYPE => [
 297                                         'cascading',
 298                                         'noncascading',
 299                                         'all'
 300                                 ],
 301                         ],
 302                         'limit' => [
 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
 308                         ],
 309                         'dir' => [
 310                                 ApiBase::PARAM_DFLT => 'ascending',
 311                                 ApiBase::PARAM_TYPE => [
 312                                         'ascending',
 313                                         'descending'
 314                                 ]
 315                         ],
 316                         'filterlanglinks' => [
 317                                 ApiBase::PARAM_TYPE => [
 318                                         'withlanglinks',
 319                                         'withoutlanglinks',
 320                                         'all'
 321                                 ],
 322                                 ApiBase::PARAM_DFLT => 'all'
 323                         ],
 324                         'prexpiry' => [
 325                                 ApiBase::PARAM_TYPE => [
 326                                         'indefinite',
 327                                         'definite',
 328                                         'all'
 329                                 ],
 330                                 ApiBase::PARAM_DFLT => 'all'
 331                         ],
 332                 ];
 333
 334                 if ( $this->getConfig()->get( 'MiserMode' ) ) {
 335                         $ret['filterredir'][ApiBase::PARAM_HELP_MSG_APPEND] = [ 'api-help-param-limited-in-miser-mode' ];
 336                 }
 337
 338                 return $ret;
 339         }
 340
 341         protected function getExamplesMessages() {
 342                 return [
 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',
 350                 ];
 351         }
 352
 353         public function getHelpUrls() {
 354                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages';
 355         }
 356 }