includes/api/ApiQueryAllpages.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 25, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( 'ApiQueryBase.php' );
  29 }
  30
  31 /**
  32  * Query module to enumerate all available pages.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryAllpages extends ApiQueryGeneratorBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent :: __construct( $query, $moduleName, 'ap' );
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator( $resultPageSet ) {
  47                 if ( $resultPageSet->isResolvingRedirects() )
  48                         $this->dieUsage( 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params' );
  49
  50                 $this->run( $resultPageSet );
  51         }
  52
  53         private function run( $resultPageSet = null ) {
  54                 $db = $this->getDB();
  55
  56                 $params = $this->extractRequestParams();
  57
  58                 // Page filters
  59                 $this->addTables( 'page' );
  60
  61                 if ( $params['filterredir'] == 'redirects' )
  62                         $this->addWhereFld( 'page_is_redirect', 1 );
  63                 else if ( $params['filterredir'] == 'nonredirects' )
  64                         $this->addWhereFld( 'page_is_redirect', 0 );
  65
  66                 $this->addWhereFld( 'page_namespace', $params['namespace'] );
  67                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  68                 $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
  69                 $this->addWhereRange( 'page_title', $dir, $from, null );
  70
  71                 if ( isset ( $params['prefix'] ) )
  72                         $this->addWhere( 'page_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
  73
  74                 if ( is_null( $resultPageSet ) ) {
  75                         $selectFields = array (
  76                                 'page_namespace',
  77                                 'page_title',
  78                                 'page_id'
  79                         );
  80                 } else {
  81                         $selectFields = $resultPageSet->getPageTableFields();
  82                 }
  83
  84                 $this->addFields( $selectFields );
  85                 $forceNameTitleIndex = true;
  86                 if ( isset ( $params['minsize'] ) ) {
  87                         $this->addWhere( 'page_len>=' . intval( $params['minsize'] ) );
  88                         $forceNameTitleIndex = false;
  89                 }
  90
  91                 if ( isset ( $params['maxsize'] ) ) {
  92                         $this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) );
  93                         $forceNameTitleIndex = false;
  94                 }
  95
  96                 // Page protection filtering
  97                 if ( !empty ( $params['prtype'] ) ) {
  98                         $this->addTables( 'page_restrictions' );
  99                         $this->addWhere( 'page_id=pr_page' );
 100                         $this->addWhere( 'pr_expiry>' . $db->addQuotes( $db->timestamp() ) );
 101                         $this->addWhereFld( 'pr_type', $params['prtype'] );
 102
 103                         if ( isset ( $params['prlevel'] ) ) {
 104                                 // Remove the empty string and '*' from the prlevel array
 105                                 $prlevel = array_diff( $params['prlevel'], array( '', '*' ) );
 106
 107                                 if ( !empty( $prlevel ) )
 108                                         $this->addWhereFld( 'pr_level', $prlevel );
 109                         }
 110                         if ( $params['prfiltercascade'] == 'cascading' )
 111                                 $this->addWhereFld( 'pr_cascade', 1 );
 112                         else if ( $params['prfiltercascade'] == 'noncascading' )
 113                                 $this->addWhereFld( 'pr_cascade', 0 );
 114
 115                         $this->addOption( 'DISTINCT' );
 116
 117                         $forceNameTitleIndex = false;
 118
 119                 } else if ( isset ( $params['prlevel'] ) ) {
 120                         $this->dieUsage( 'prlevel may not be used without prtype', 'params' );
 121                 }
 122
 123                 if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
 124                         $this->addTables( 'langlinks' );
 125                         $this->addJoinConds( array( 'langlinks' => array( 'LEFT JOIN', 'page_id=ll_from' ) ) );
 126                         $this->addWhere( 'll_from IS NULL' );
 127                         $forceNameTitleIndex = false;
 128                 } else if ( $params['filterlanglinks'] == 'withlanglinks' ) {
 129                         $this->addTables( 'langlinks' );
 130                         $this->addWhere( 'page_id=ll_from' );
 131                         $this->addOption( 'STRAIGHT_JOIN' );
 132                         // We have to GROUP BY all selected fields to stop
 133                         // PostgreSQL from whining
 134                         $this->addOption( 'GROUP BY', implode( ', ', $selectFields ) );
 135                         $forceNameTitleIndex = false;
 136                 }
 137
 138                 if ( $forceNameTitleIndex )
 139                         $this->addOption( 'USE INDEX', 'name_title' );
 140
 141                 $limit = $params['limit'];
 142                 $this->addOption( 'LIMIT', $limit + 1 );
 143                 $res = $this->select( __METHOD__ );
 144
 145                 $count = 0;
 146                 $result = $this->getResult();
 147                 while ( $row = $db->fetchObject( $res ) ) {
 148                         if ( ++ $count > $limit ) {
 149                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 150                                 // TODO: Security issue - if the user has no right to view next title, it will still be shown
 151                                 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title ) );
 152                                 break;
 153                         }
 154
 155                         if ( is_null( $resultPageSet ) ) {
 156                                 $title = Title :: makeTitle( $row->page_namespace, $row->page_title );
 157                                 $vals = array(
 158                                         'pageid' => intval( $row->page_id ),
 159                                         'ns' => intval( $title->getNamespace() ),
 160                                         'title' => $title->getPrefixedText() );
 161                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
 162                                 if ( !$fit )
 163                                 {
 164                                         $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title ) );
 165                                         break;
 166                                 }
 167                         } else {
 168                                 $resultPageSet->processDbRow( $row );
 169                         }
 170                 }
 171                 $db->freeResult( $res );
 172
 173                 if ( is_null( $resultPageSet ) ) {
 174                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' );
 175                 }
 176         }
 177
 178         public function getAllowedParams() {
 179                 global $wgRestrictionTypes, $wgRestrictionLevels;
 180
 181                 return array (
 182                         'from' => null,
 183                         'prefix' => null,
 184                         'namespace' => array (
 185                                 ApiBase :: PARAM_DFLT => 0,
 186                                 ApiBase :: PARAM_TYPE => 'namespace',
 187                         ),
 188                         'filterredir' => array (
 189                                 ApiBase :: PARAM_DFLT => 'all',
 190                                 ApiBase :: PARAM_TYPE => array (
 191                                         'all',
 192                                         'redirects',
 193                                         'nonredirects'
 194                                 )
 195                         ),
 196                         'minsize' => array (
 197                                 ApiBase :: PARAM_TYPE => 'integer',
 198                         ),
 199                         'maxsize' => array (
 200                                 ApiBase :: PARAM_TYPE => 'integer',
 201                         ),
 202                         'prtype' => array (
 203                                 ApiBase :: PARAM_TYPE => $wgRestrictionTypes,
 204                                 ApiBase :: PARAM_ISMULTI => true
 205                         ),
 206                         'prlevel' => array (
 207                                 ApiBase :: PARAM_TYPE => $wgRestrictionLevels,
 208                                 ApiBase :: PARAM_ISMULTI => true
 209                         ),
 210                         'prfiltercascade' => array (
 211                                 ApiBase :: PARAM_DFLT => 'all',
 212                                 ApiBase :: PARAM_TYPE => array (
 213                                         'cascading',
 214                                         'noncascading',
 215                                         'all'
 216                                 ),
 217                         ),
 218                         'limit' => array (
 219                                 ApiBase :: PARAM_DFLT => 10,
 220                                 ApiBase :: PARAM_TYPE => 'limit',
 221                                 ApiBase :: PARAM_MIN => 1,
 222                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 223                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 224                         ),
 225                         'dir' => array (
 226                                 ApiBase :: PARAM_DFLT => 'ascending',
 227                                 ApiBase :: PARAM_TYPE => array (
 228                                         'ascending',
 229                                         'descending'
 230                                 )
 231                         ),
 232                         'filterlanglinks' => array(
 233                                 ApiBase :: PARAM_TYPE => array(
 234                                         'withlanglinks',
 235                                         'withoutlanglinks',
 236                                         'all'
 237                                 ),
 238                                 ApiBase :: PARAM_DFLT => 'all'
 239                         )
 240                 );
 241         }
 242
 243         public function getParamDescription() {
 244                 return array (
 245                         'from' => 'The page title to start enumerating from.',
 246                         'prefix' => 'Search for all page titles that begin with this value.',
 247                         'namespace' => 'The namespace to enumerate.',
 248                         'filterredir' => 'Which pages to list.',
 249                         'dir' => 'The direction in which to list',
 250                         'minsize' => 'Limit to pages with at least this many bytes',
 251                         'maxsize' => 'Limit to pages with at most this many bytes',
 252                         'prtype' => 'Limit to protected pages only',
 253                         'prlevel' => 'The protection level (must be used with apprtype= parameter)',
 254                         'prfiltercascade' => 'Filter protections based on cascadingness (ignored when apprtype isn\'t set)',
 255                         'filterlanglinks' => 'Filter based on whether a page has langlinks',
 256                         'limit' => 'How many total pages to return.'
 257                 );
 258         }
 259
 260         public function getDescription() {
 261                 return 'Enumerate all pages sequentially in a given namespace';
 262         }
 263
 264         public function getPossibleErrors() {
 265                 return array_merge( parent::getPossibleErrors(), array(
 266                         array( 'code' => 'params', 'info' => 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator' ),
 267                         array( 'code' => 'params', 'info' => 'prlevel may not be used without prtype' ),
 268                 ) );
 269         }
 270
 271         protected function getExamples() {
 272                 return array (
 273                         'Simple Use',
 274                         ' Show a list of pages starting at the letter "B"',
 275                         '  api.php?action=query&list=allpages&apfrom=B',
 276                         'Using as Generator',
 277                         ' Show info about 4 pages starting at the letter "T"',
 278                         '  api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
 279                         ' Show content of first 2 non-redirect pages begining at "Re"',
 280                         '  api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
 281                 );
 282         }
 283
 284         public function getVersion() {
 285                 return __CLASS__ . ': $Id$';
 286         }
 287 }