includes/api/ApiQueryAllCategories.php

   1 <?php
   2 /**
   3  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Query module to enumerate all categories, even the ones that don't have
  25  * category pages.
  26  *
  27  * @ingroup API
  28  */
  29 class ApiQueryAllCategories extends ApiQueryGeneratorBase {
  30
  31         public function __construct( ApiQuery $query, $moduleName ) {
  32                 parent::__construct( $query, $moduleName, 'ac' );
  33         }
  34
  35         public function execute() {
  36                 $this->run();
  37         }
  38
  39         public function getCacheMode( $params ) {
  40                 return 'public';
  41         }
  42
  43         public function executeGenerator( $resultPageSet ) {
  44                 $this->run( $resultPageSet );
  45         }
  46
  47         /**
  48          * @param ApiPageSet $resultPageSet
  49          */
  50         private function run( $resultPageSet = null ) {
  51                 $db = $this->getDB();
  52                 $params = $this->extractRequestParams();
  53
  54                 $this->addTables( 'category' );
  55                 $this->addFields( 'cat_title' );
  56
  57                 if ( !is_null( $params['continue'] ) ) {
  58                         $cont = explode( '|', $params['continue'] );
  59                         $this->dieContinueUsageIf( count( $cont ) != 1 );
  60                         $op = $params['dir'] == 'descending' ? '<' : '>';
  61                         $cont_from = $db->addQuotes( $cont[0] );
  62                         $this->addWhere( "cat_title $op= $cont_from" );
  63                 }
  64
  65                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  66                 $from = ( $params['from'] === null
  67                         ? null
  68                         : $this->titlePartToKey( $params['from'], NS_CATEGORY ) );
  69                 $to = ( $params['to'] === null
  70                         ? null
  71                         : $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
  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' . $db->buildLike(
  84                                 $this->titlePartToKey( $params['prefix'], NS_CATEGORY ),
  85                                 $db->anyString() ) );
  86                 }
  87
  88                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  89                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  90                 $this->addOption( 'ORDER BY', 'cat_title' . $sort );
  91
  92                 $prop = array_flip( $params['prop'] );
  93                 $this->addFieldsIf( [ 'cat_pages', 'cat_subcats', 'cat_files' ], isset( $prop['size'] ) );
  94                 if ( isset( $prop['hidden'] ) ) {
  95                         $this->addTables( [ 'page', 'page_props' ] );
  96                         $this->addJoinConds( [
  97                                 'page' => [ 'LEFT JOIN', [
  98                                         'page_namespace' => NS_CATEGORY,
  99                                         'page_title=cat_title' ] ],
 100                                 'page_props' => [ 'LEFT JOIN', [
 101                                         'pp_page=page_id',
 102                                         'pp_propname' => 'hiddencat' ] ],
 103                         ] );
 104                         $this->addFields( [ 'cat_hidden' => 'pp_propname' ] );
 105                 }
 106
 107                 $res = $this->select( __METHOD__ );
 108
 109                 $pages = [];
 110
 111                 $result = $this->getResult();
 112                 $count = 0;
 113                 foreach ( $res as $row ) {
 114                         if ( ++$count > $params['limit'] ) {
 115                                 // We've reached the one extra which shows that there are
 116                                 // additional cats to be had. Stop here...
 117                                 $this->setContinueEnumParameter( 'continue', $row->cat_title );
 118                                 break;
 119                         }
 120
 121                         // Normalize titles
 122                         $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
 123                         if ( !is_null( $resultPageSet ) ) {
 124                                 $pages[] = $titleObj;
 125                         } else {
 126                                 $item = [];
 127                                 ApiResult::setContentValue( $item, 'category', $titleObj->getText() );
 128                                 if ( isset( $prop['size'] ) ) {
 129                                         $item['size'] = intval( $row->cat_pages );
 130                                         $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
 131                                         $item['files'] = intval( $row->cat_files );
 132                                         $item['subcats'] = intval( $row->cat_subcats );
 133                                 }
 134                                 if ( isset( $prop['hidden'] ) ) {
 135                                         $item['hidden'] = (bool)$row->cat_hidden;
 136                                 }
 137                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
 138                                 if ( !$fit ) {
 139                                         $this->setContinueEnumParameter( 'continue', $row->cat_title );
 140                                         break;
 141                                 }
 142                         }
 143                 }
 144
 145                 if ( is_null( $resultPageSet ) ) {
 146                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' );
 147                 } else {
 148                         $resultPageSet->populateFromTitles( $pages );
 149                 }
 150         }
 151
 152         public function getAllowedParams() {
 153                 return [
 154                         'from' => null,
 155                         'continue' => [
 156                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 157                         ],
 158                         'to' => null,
 159                         'prefix' => null,
 160                         'dir' => [
 161                                 ApiBase::PARAM_DFLT => 'ascending',
 162                                 ApiBase::PARAM_TYPE => [
 163                                         'ascending',
 164                                         'descending'
 165                                 ],
 166                         ],
 167                         'min' => [
 168                                 ApiBase::PARAM_TYPE => 'integer'
 169                         ],
 170                         'max' => [
 171                                 ApiBase::PARAM_TYPE => 'integer'
 172                         ],
 173                         'limit' => [
 174                                 ApiBase::PARAM_DFLT => 10,
 175                                 ApiBase::PARAM_TYPE => 'limit',
 176                                 ApiBase::PARAM_MIN => 1,
 177                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 178                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 179                         ],
 180                         'prop' => [
 181                                 ApiBase::PARAM_TYPE => [ 'size', 'hidden' ],
 182                                 ApiBase::PARAM_DFLT => '',
 183                                 ApiBase::PARAM_ISMULTI => true,
 184                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 185                         ],
 186                 ];
 187         }
 188
 189         protected function getExamplesMessages() {
 190                 return [
 191                         'action=query&list=allcategories&acprop=size'
 192                                 => 'apihelp-query+allcategories-example-size',
 193                         'action=query&generator=allcategories&gacprefix=List&prop=info'
 194                                 => 'apihelp-query+allcategories-example-generator',
 195                 ];
 196         }
 197
 198         public function getHelpUrls() {
 199                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
 200         }
 201 }