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( $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 $resultPageSet ApiPageSet
  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 = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
  71                 $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) );
  72                 $this->addWhereRange( 'cat_title', $dir, $from, $to );
  73
  74                 $min = $params['min'];
  75                 $max = $params['max'];
  76                 if ( $dir == 'newer' ) {
  77                         $this->addWhereRange( 'cat_pages', 'newer', $min, $max );
  78                 } else {
  79                         $this->addWhereRange( 'cat_pages', 'older', $max, $min );
  80                 }
  81
  82                 if ( isset( $params['prefix'] ) ) {
  83                         $this->addWhere( 'cat_title' .
  84                                 $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
  85                 }
  86
  87                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  88                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  89                 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
  90
  91                 $prop = array_flip( $params['prop'] );
  92                 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
  93                 if ( isset( $prop['hidden'] ) ) {
  94                         $this->addTables( array( 'page', 'page_props' ) );
  95                         $this->addJoinConds( array(
  96                                 'page' => array( 'LEFT JOIN', array(
  97                                         'page_namespace' => NS_CATEGORY,
  98                                         'page_title=cat_title' ) ),
  99                                 'page_props' => array( 'LEFT JOIN', array(
 100                                         'pp_page=page_id',
 101                                         'pp_propname' => 'hiddencat' ) ),
 102                         ) );
 103                         $this->addFields( array( 'cat_hidden' => 'pp_propname' ) );
 104                 }
 105
 106                 $res = $this->select( __METHOD__ );
 107
 108                 $pages = array();
 109
 110                 $result = $this->getResult();
 111                 $count = 0;
 112                 foreach ( $res as $row ) {
 113                         if ( ++$count > $params['limit'] ) {
 114                                 // We've reached the one extra which shows that there are
 115                                 // additional cats to be had. Stop here...
 116                                 $this->setContinueEnumParameter( 'continue', $row->cat_title );
 117                                 break;
 118                         }
 119
 120                         // Normalize titles
 121                         $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
 122                         if ( !is_null( $resultPageSet ) ) {
 123                                 $pages[] = $titleObj;
 124                         } else {
 125                                 $item = array();
 126                                 ApiResult::setContent( $item, $titleObj->getText() );
 127                                 if ( isset( $prop['size'] ) ) {
 128                                         $item['size'] = intval( $row->cat_pages );
 129                                         $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
 130                                         $item['files'] = intval( $row->cat_files );
 131                                         $item['subcats'] = intval( $row->cat_subcats );
 132                                 }
 133                                 if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
 134                                         $item['hidden'] = '';
 135                                 }
 136                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
 137                                 if ( !$fit ) {
 138                                         $this->setContinueEnumParameter( 'continue', $row->cat_title );
 139                                         break;
 140                                 }
 141                         }
 142                 }
 143
 144                 if ( is_null( $resultPageSet ) ) {
 145                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
 146                 } else {
 147                         $resultPageSet->populateFromTitles( $pages );
 148                 }
 149         }
 150
 151         public function getAllowedParams() {
 152                 return array(
 153                         'from' => null,
 154                         'continue' => null,
 155                         'to' => null,
 156                         'prefix' => null,
 157                         'dir' => array(
 158                                 ApiBase::PARAM_DFLT => 'ascending',
 159                                 ApiBase::PARAM_TYPE => array(
 160                                         'ascending',
 161                                         'descending'
 162                                 ),
 163                         ),
 164                         'min' => array(
 165                                 ApiBase::PARAM_DFLT => null,
 166                                 ApiBase::PARAM_TYPE => 'integer'
 167                         ),
 168                         'max' => array(
 169                                 ApiBase::PARAM_DFLT => null,
 170                                 ApiBase::PARAM_TYPE => 'integer'
 171                         ),
 172                         'limit' => array(
 173                                 ApiBase::PARAM_DFLT => 10,
 174                                 ApiBase::PARAM_TYPE => 'limit',
 175                                 ApiBase::PARAM_MIN => 1,
 176                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 177                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 178                         ),
 179                         'prop' => array(
 180                                 ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
 181                                 ApiBase::PARAM_DFLT => '',
 182                                 ApiBase::PARAM_ISMULTI => true
 183                         ),
 184                 );
 185         }
 186
 187         public function getParamDescription() {
 188                 return array(
 189                         'from' => 'The category to start enumerating from',
 190                         'continue' => 'When more results are available, use this to continue',
 191                         'to' => 'The category to stop enumerating at',
 192                         'prefix' => 'Search for all category titles that begin with this value',
 193                         'dir' => 'Direction to sort in',
 194                         'min' => 'Minimum number of category members',
 195                         'max' => 'Maximum number of category members',
 196                         'limit' => 'How many categories to return',
 197                         'prop' => array(
 198                                 'Which properties to get',
 199                                 ' size    - Adds number of pages in the category',
 200                                 ' hidden  - Tags categories that are hidden with __HIDDENCAT__',
 201                         ),
 202                 );
 203         }
 204
 205         public function getResultProperties() {
 206                 return array(
 207                         '' => array(
 208                                 '*' => 'string'
 209                         ),
 210                         'size' => array(
 211                                 'size' => 'integer',
 212                                 'pages' => 'integer',
 213                                 'files' => 'integer',
 214                                 'subcats' => 'integer'
 215                         ),
 216                         'hidden' => array(
 217                                 'hidden' => 'boolean'
 218                         )
 219                 );
 220         }
 221
 222         public function getDescription() {
 223                 return 'Enumerate all categories';
 224         }
 225
 226         public function getExamples() {
 227                 return array(
 228                         'api.php?action=query&list=allcategories&acprop=size',
 229                         'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
 230                 );
 231         }
 232
 233         public function getHelpUrls() {
 234                 return 'https://www.mediawiki.org/wiki/API:Allcategories';
 235         }
 236 }