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