includes/api/ApiQueryAllPages.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 25, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  */
  26 use MediaWiki\MediaWikiServices;
  27
  28 /**
  29  * Query module to enumerate all available pages.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiQueryAllPages extends ApiQueryGeneratorBase {
  34
  35         public function __construct( ApiQuery $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'ap' );
  37         }
  38
  39         public function execute() {
  40                 $this->run();
  41         }
  42
  43         public function getCacheMode( $params ) {
  44                 return 'public';
  45         }
  46
  47         /**
  48          * @param ApiPageSet $resultPageSet
  49          * @return void
  50          */
  51         public function executeGenerator( $resultPageSet ) {
  52                 if ( $resultPageSet->isResolvingRedirects() ) {
  53                         $this->dieWithError( 'apierror-allpages-generator-redirects', 'params' );
  54                 }
  55
  56                 $this->run( $resultPageSet );
  57         }
  58
  59         /**
  60          * @param ApiPageSet $resultPageSet
  61          * @return void
  62          */
  63         private function run( $resultPageSet = null ) {
  64                 $db = $this->getDB();
  65
  66                 $params = $this->extractRequestParams();
  67
  68                 // Page filters
  69                 $this->addTables( 'page' );
  70
  71                 if ( !is_null( $params['continue'] ) ) {
  72                         $cont = explode( '|', $params['continue'] );
  73                         $this->dieContinueUsageIf( count( $cont ) != 1 );
  74                         $op = $params['dir'] == 'descending' ? '<' : '>';
  75                         $cont_from = $db->addQuotes( $cont[0] );
  76                         $this->addWhere( "page_title $op= $cont_from" );
  77                 }
  78
  79                 $miserMode = $this->getConfig()->get( 'MiserMode' );
  80                 if ( !$miserMode ) {
  81                         if ( $params['filterredir'] == 'redirects' ) {
  82                                 $this->addWhereFld( 'page_is_redirect', 1 );
  83                         } elseif ( $params['filterredir'] == 'nonredirects' ) {
  84                                 $this->addWhereFld( 'page_is_redirect', 0 );
  85                         }
  86                 }
  87
  88                 $this->addWhereFld( 'page_namespace', $params['namespace'] );
  89                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  90                 $from = ( $params['from'] === null
  91                         ? null
  92                         : $this->titlePartToKey( $params['from'], $params['namespace'] ) );
  93                 $to = ( $params['to'] === null
  94                         ? null
  95                         : $this->titlePartToKey( $params['to'], $params['namespace'] ) );
  96                 $this->addWhereRange( 'page_title', $dir, $from, $to );
  97
  98                 if ( isset( $params['prefix'] ) ) {
  99                         $this->addWhere( 'page_title' . $db->buildLike(
 100                                 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
 101                                 $db->anyString() ) );
 102                 }
 103
 104                 if ( is_null( $resultPageSet ) ) {
 105                         $selectFields = [
 106                                 'page_namespace',
 107                                 'page_title',
 108                                 'page_id'
 109                         ];
 110                 } else {
 111                         $selectFields = $resultPageSet->getPageTableFields();
 112                 }
 113
 114                 $miserModeFilterRedirValue = null;
 115                 $miserModeFilterRedir = $miserMode && $params['filterredir'] !== 'all';
 116                 if ( $miserModeFilterRedir ) {
 117                         $selectFields[] = 'page_is_redirect';
 118
 119                         if ( $params['filterredir'] == 'redirects' ) {
 120                                 $miserModeFilterRedirValue = 1;
 121                         } elseif ( $params['filterredir'] == 'nonredirects' ) {
 122                                 $miserModeFilterRedirValue = 0;
 123                         }
 124                 }
 125
 126                 $this->addFields( $selectFields );
 127                 $forceNameTitleIndex = true;
 128                 if ( isset( $params['minsize'] ) ) {
 129                         $this->addWhere( 'page_len>=' . intval( $params['minsize'] ) );
 130                         $forceNameTitleIndex = false;
 131                 }
 132
 133                 if ( isset( $params['maxsize'] ) ) {
 134                         $this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) );
 135                         $forceNameTitleIndex = false;
 136                 }
 137
 138                 // Page protection filtering
 139                 if ( count( $params['prtype'] ) || $params['prexpiry'] != 'all' ) {
 140                         $this->addTables( 'page_restrictions' );
 141                         $this->addWhere( 'page_id=pr_page' );
 142                         $this->addWhere( "pr_expiry > {$db->addQuotes( $db->timestamp() )} OR pr_expiry IS NULL" );
 143
 144                         if ( count( $params['prtype'] ) ) {
 145                                 $this->addWhereFld( 'pr_type', $params['prtype'] );
 146
 147                                 if ( isset( $params['prlevel'] ) ) {
 148                                         // Remove the empty string and '*' from the prlevel array
 149                                         $prlevel = array_diff( $params['prlevel'], [ '', '*' ] );
 150
 151                                         if ( count( $prlevel ) ) {
 152                                                 $this->addWhereFld( 'pr_level', $prlevel );
 153                                         }
 154                                 }
 155                                 if ( $params['prfiltercascade'] == 'cascading' ) {
 156                                         $this->addWhereFld( 'pr_cascade', 1 );
 157                                 } elseif ( $params['prfiltercascade'] == 'noncascading' ) {
 158                                         $this->addWhereFld( 'pr_cascade', 0 );
 159                                 }
 160                         }
 161                         $forceNameTitleIndex = false;
 162
 163                         if ( $params['prexpiry'] == 'indefinite' ) {
 164                                 $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" );
 165                         } elseif ( $params['prexpiry'] == 'definite' ) {
 166                                 $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" );
 167                         }
 168
 169                         $this->addOption( 'DISTINCT' );
 170                 } elseif ( isset( $params['prlevel'] ) ) {
 171                         $this->dieWithError(
 172                                 [ 'apierror-invalidparammix-mustusewith', 'prlevel', 'prtype' ], 'invalidparammix'
 173                         );
 174                 }
 175
 176                 if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
 177                         $this->addTables( 'langlinks' );
 178                         $this->addJoinConds( [ 'langlinks' => [ 'LEFT JOIN', 'page_id=ll_from' ] ] );
 179                         $this->addWhere( 'll_from IS NULL' );
 180                         $forceNameTitleIndex = false;
 181                 } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) {
 182                         $this->addTables( 'langlinks' );
 183                         $this->addWhere( 'page_id=ll_from' );
 184                         $this->addOption( 'STRAIGHT_JOIN' );
 185
 186                         // MySQL filesorts if we use a GROUP BY that works with the rules
 187                         // in the 1992 SQL standard (it doesn't like having the
 188                         // constant-in-WHERE page_namespace column in there). Using the
 189                         // 1999 rules works fine, but that breaks other DBs. Sigh.
 190                         /// @todo Once we drop support for 1992-rule DBs, we can simplify this.
 191                         $dbType = $db->getType();
 192                         if ( $dbType === 'mysql' || $dbType === 'sqlite' ) {
 193                                 // Ignore the rules, or 1999 rules if you count unique keys
 194                                 // over non-NULL columns as satisfying the requirement for
 195                                 // "functional dependency" and don't require including
 196                                 // constant-in-WHERE columns in the GROUP BY.
 197                                 $this->addOption( 'GROUP BY', [ 'page_title' ] );
 198                         } elseif ( $dbType === 'postgres' && $db->getServerVersion() >= 9.1 ) {
 199                                 // 1999 rules only counting primary keys
 200                                 $this->addOption( 'GROUP BY', [ 'page_title', 'page_id' ] );
 201                         } else {
 202                                 // 1992 rules
 203                                 $this->addOption( 'GROUP BY', $selectFields );
 204                         }
 205
 206                         $forceNameTitleIndex = false;
 207                 }
 208
 209                 if ( $forceNameTitleIndex ) {
 210                         $this->addOption( 'USE INDEX', 'name_title' );
 211                 }
 212
 213                 $limit = $params['limit'];
 214                 $this->addOption( 'LIMIT', $limit + 1 );
 215                 $res = $this->select( __METHOD__ );
 216
 217                 // Get gender information
 218                 if ( MWNamespace::hasGenderDistinction( $params['namespace'] ) ) {
 219                         $users = [];
 220                         foreach ( $res as $row ) {
 221                                 $users[] = $row->page_title;
 222                         }
 223                         MediaWikiServices::getInstance()->getGenderCache()->doQuery( $users, __METHOD__ );
 224                         $res->rewind(); // reset
 225                 }
 226
 227                 $count = 0;
 228                 $result = $this->getResult();
 229                 foreach ( $res as $row ) {
 230                         if ( ++$count > $limit ) {
 231                                 // We've reached the one extra which shows that there are
 232                                 // additional pages to be had. Stop here...
 233                                 $this->setContinueEnumParameter( 'continue', $row->page_title );
 234                                 break;
 235                         }
 236
 237                         if ( $miserModeFilterRedir && (int)$row->page_is_redirect !== $miserModeFilterRedirValue ) {
 238                                 // Filter implemented in PHP due to being in Miser Mode
 239                                 continue;
 240                         }
 241
 242                         if ( is_null( $resultPageSet ) ) {
 243                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 244                                 $vals = [
 245                                         'pageid' => intval( $row->page_id ),
 246                                         'ns' => intval( $title->getNamespace() ),
 247                                         'title' => $title->getPrefixedText()
 248                                 ];
 249                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 250                                 if ( !$fit ) {
 251                                         $this->setContinueEnumParameter( 'continue', $row->page_title );
 252                                         break;
 253                                 }
 254                         } else {
 255                                 $resultPageSet->processDbRow( $row );
 256                         }
 257                 }
 258
 259                 if ( is_null( $resultPageSet ) ) {
 260                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'p' );
 261                 }
 262         }
 263
 264         public function getAllowedParams() {
 265                 $ret = [
 266                         'from' => null,
 267                         'continue' => [
 268                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 269                         ],
 270                         'to' => null,
 271                         'prefix' => null,
 272                         'namespace' => [
 273                                 ApiBase::PARAM_DFLT => NS_MAIN,
 274                                 ApiBase::PARAM_TYPE => 'namespace',
 275                         ],
 276                         'filterredir' => [
 277                                 ApiBase::PARAM_DFLT => 'all',
 278                                 ApiBase::PARAM_TYPE => [
 279                                         'all',
 280                                         'redirects',
 281                                         'nonredirects'
 282                                 ]
 283                         ],
 284                         'minsize' => [
 285                                 ApiBase::PARAM_TYPE => 'integer',
 286                         ],
 287                         'maxsize' => [
 288                                 ApiBase::PARAM_TYPE => 'integer',
 289                         ],
 290                         'prtype' => [
 291                                 ApiBase::PARAM_TYPE => Title::getFilteredRestrictionTypes( true ),
 292                                 ApiBase::PARAM_ISMULTI => true
 293                         ],
 294                         'prlevel' => [
 295                                 ApiBase::PARAM_TYPE => $this->getConfig()->get( 'RestrictionLevels' ),
 296                                 ApiBase::PARAM_ISMULTI => true
 297                         ],
 298                         'prfiltercascade' => [
 299                                 ApiBase::PARAM_DFLT => 'all',
 300                                 ApiBase::PARAM_TYPE => [
 301                                         'cascading',
 302                                         'noncascading',
 303                                         'all'
 304                                 ],
 305                         ],
 306                         'limit' => [
 307                                 ApiBase::PARAM_DFLT => 10,
 308                                 ApiBase::PARAM_TYPE => 'limit',
 309                                 ApiBase::PARAM_MIN => 1,
 310                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 311                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 312                         ],
 313                         'dir' => [
 314                                 ApiBase::PARAM_DFLT => 'ascending',
 315                                 ApiBase::PARAM_TYPE => [
 316                                         'ascending',
 317                                         'descending'
 318                                 ]
 319                         ],
 320                         'filterlanglinks' => [
 321                                 ApiBase::PARAM_TYPE => [
 322                                         'withlanglinks',
 323                                         'withoutlanglinks',
 324                                         'all'
 325                                 ],
 326                                 ApiBase::PARAM_DFLT => 'all'
 327                         ],
 328                         'prexpiry' => [
 329                                 ApiBase::PARAM_TYPE => [
 330                                         'indefinite',
 331                                         'definite',
 332                                         'all'
 333                                 ],
 334                                 ApiBase::PARAM_DFLT => 'all'
 335                         ],
 336                 ];
 337
 338                 if ( $this->getConfig()->get( 'MiserMode' ) ) {
 339                         $ret['filterredir'][ApiBase::PARAM_HELP_MSG_APPEND] = [ 'api-help-param-limited-in-miser-mode' ];
 340                 }
 341
 342                 return $ret;
 343         }
 344
 345         protected function getExamplesMessages() {
 346                 return [
 347                         'action=query&list=allpages&apfrom=B'
 348                                 => 'apihelp-query+allpages-example-B',
 349                         'action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info'
 350                                 => 'apihelp-query+allpages-example-generator',
 351                         'action=query&generator=allpages&gaplimit=2&' .
 352                                 'gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
 353                                 => 'apihelp-query+allpages-example-generator-revisions',
 354                 ];
 355         }
 356
 357         public function getHelpUrls() {
 358                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages';
 359         }
 360 }