includes/api/ApiQueryAllCategories.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on December 12, 2007
   6  *
   7  * Copyright © 2007 Roan Kattouw "<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
  27 /**
  28  * Query module to enumerate all categories, even the ones that don't have
  29  * category pages.
  30  *
  31  * @ingroup API
  32  */
  33 class ApiQueryAllCategories extends ApiQueryGeneratorBase {
  34
  35         public function __construct( ApiQuery $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'ac' );
  37         }
  38
  39         public function execute() {
  40                 $this->run();
  41         }
  42
  43         public function getCacheMode( $params ) {
  44                 return 'public';
  45         }
  46
  47         public function executeGenerator( $resultPageSet ) {
  48                 $this->run( $resultPageSet );
  49         }
  50
  51         /**
  52          * @param ApiPageSet $resultPageSet
  53          */
  54         private function run( $resultPageSet = null ) {
  55                 $db = $this->getDB();
  56                 $params = $this->extractRequestParams();
  57
  58                 $this->addTables( 'category' );
  59                 $this->addFields( 'cat_title' );
  60
  61                 if ( !is_null( $params['continue'] ) ) {
  62                         $cont = explode( '|', $params['continue'] );
  63                         $this->dieContinueUsageIf( count( $cont ) != 1 );
  64                         $op = $params['dir'] == 'descending' ? '<' : '>';
  65                         $cont_from = $db->addQuotes( $cont[0] );
  66                         $this->addWhere( "cat_title $op= $cont_from" );
  67                 }
  68
  69                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  70                 $from = ( $params['from'] === null
  71                         ? null
  72                         : $this->titlePartToKey( $params['from'], NS_CATEGORY ) );
  73                 $to = ( $params['to'] === null
  74                         ? null
  75                         : $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
  76                 $this->addWhereRange( 'cat_title', $dir, $from, $to );
  77
  78                 $min = $params['min'];
  79                 $max = $params['max'];
  80                 if ( $dir == 'newer' ) {
  81                         $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
  82                 } else {
  83                         $this->addWhereRange( 'cat_pages', 'older', $max, $min );
  84                 }
  85
  86                 if ( isset( $params['prefix'] ) ) {
  87                         $this->addWhere( 'cat_title' . $db->buildLike(
  88                                 $this->titlePartToKey( $params['prefix'], NS_CATEGORY ),
  89                                 $db->anyString() ) );
  90                 }
  91
  92                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  93                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  94                 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
  95
  96                 $prop = array_flip( $params['prop'] );
  97                 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
  98                 if ( isset( $prop['hidden'] ) ) {
  99                         $this->addTables( array( 'page', 'page_props' ) );
 100                         $this->addJoinConds( array(
 101                                 'page' => array( 'LEFT JOIN', array(
 102                                         'page_namespace' => NS_CATEGORY,
 103                                         'page_title=cat_title' ) ),
 104                                 'page_props' => array( 'LEFT JOIN', array(
 105                                         'pp_page=page_id',
 106                                         'pp_propname' => 'hiddencat' ) ),
 107                         ) );
 108                         $this->addFields( array( 'cat_hidden' => 'pp_propname' ) );
 109                 }
 110
 111                 $res = $this->select( __METHOD__ );
 112
 113                 $pages = array();
 114
 115                 $result = $this->getResult();
 116                 $count = 0;
 117                 foreach ( $res as $row ) {
 118                         if ( ++$count > $params['limit'] ) {
 119                                 // We've reached the one extra which shows that there are
 120                                 // additional cats to be had. Stop here...
 121                                 $this->setContinueEnumParameter( 'continue', $row->cat_title );
 122                                 break;
 123                         }
 124
 125                         // Normalize titles
 126                         $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
 127                         if ( !is_null( $resultPageSet ) ) {
 128                                 $pages[] = $titleObj;
 129                         } else {
 130                                 $item = array();
 131                                 ApiResult::setContent( $item, $titleObj->getText() );
 132                                 if ( isset( $prop['size'] ) ) {
 133                                         $item['size'] = intval( $row->cat_pages );
 134                                         $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
 135                                         $item['files'] = intval( $row->cat_files );
 136                                         $item['subcats'] = intval( $row->cat_subcats );
 137                                 }
 138                                 if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
 139                                         $item['hidden'] = '';
 140                                 }
 141                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
 142                                 if ( !$fit ) {
 143                                         $this->setContinueEnumParameter( 'continue', $row->cat_title );
 144                                         break;
 145                                 }
 146                         }
 147                 }
 148
 149                 if ( is_null( $resultPageSet ) ) {
 150                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
 151                 } else {
 152                         $resultPageSet->populateFromTitles( $pages );
 153                 }
 154         }
 155
 156         public function getAllowedParams() {
 157                 return array(
 158                         'from' => null,
 159                         'continue' => null,
 160                         'to' => null,
 161                         'prefix' => null,
 162                         'dir' => array(
 163                                 ApiBase::PARAM_DFLT => 'ascending',
 164                                 ApiBase::PARAM_TYPE => array(
 165                                         'ascending',
 166                                         'descending'
 167                                 ),
 168                         ),
 169                         'min' => array(
 170                                 ApiBase::PARAM_DFLT => null,
 171                                 ApiBase::PARAM_TYPE => 'integer'
 172                         ),
 173                         'max' => array(
 174                                 ApiBase::PARAM_DFLT => null,
 175                                 ApiBase::PARAM_TYPE => 'integer'
 176                         ),
 177                         'limit' => array(
 178                                 ApiBase::PARAM_DFLT => 10,
 179                                 ApiBase::PARAM_TYPE => 'limit',
 180                                 ApiBase::PARAM_MIN => 1,
 181                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 182                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 183                         ),
 184                         'prop' => array(
 185                                 ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
 186                                 ApiBase::PARAM_DFLT => '',
 187                                 ApiBase::PARAM_ISMULTI => true
 188                         ),
 189                 );
 190         }
 191
 192         public function getParamDescription() {
 193                 return array(
 194                         'from' => 'The category to start enumerating from',
 195                         'continue' => 'When more results are available, use this to continue',
 196                         'to' => 'The category to stop enumerating at',
 197                         'prefix' => 'Search for all category titles that begin with this value',
 198                         'dir' => 'Direction to sort in',
 199                         'min' => 'Minimum number of category members',
 200                         'max' => 'Maximum number of category members',
 201                         'limit' => 'How many categories to return',
 202                         'prop' => array(
 203                                 'Which properties to get',
 204                                 ' size    - Adds number of pages in the category',
 205                                 ' hidden  - Tags categories that are hidden with __HIDDENCAT__',
 206                         ),
 207                 );
 208         }
 209
 210         public function getResultProperties() {
 211                 return array(
 212                         '' => array(
 213                                 '*' => 'string'
 214                         ),
 215                         'size' => array(
 216                                 'size' => 'integer',
 217                                 'pages' => 'integer',
 218                                 'files' => 'integer',
 219                                 'subcats' => 'integer'
 220                         ),
 221                         'hidden' => array(
 222                                 'hidden' => 'boolean'
 223                         )
 224                 );
 225         }
 226
 227         public function getDescription() {
 228                 return 'Enumerate all categories.';
 229         }
 230
 231         public function getExamples() {
 232                 return array(
 233                         'api.php?action=query&list=allcategories&acprop=size',
 234                         'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
 235                 );
 236         }
 237
 238         public function getHelpUrls() {
 239                 return 'https://www.mediawiki.org/wiki/API:Allcategories';
 240         }
 241 }