includes/api/ApiQueryAllCategories.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.8+
   4  *
   5  * Created on December 12, 2007
   6  *
   7  * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
   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 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiQueryBase.php' );
  30 }
  31
  32 /**
  33  * Query module to enumerate all categories, even the ones that don't have
  34  * category pages.
  35  *
  36  * @ingroup API
  37  */
  38 class ApiQueryAllCategories extends ApiQueryGeneratorBase {
  39
  40         public function __construct( $query, $moduleName ) {
  41                 parent::__construct( $query, $moduleName, 'ac' );
  42         }
  43
  44         public function execute() {
  45                 $this->run();
  46         }
  47
  48         public function getCacheMode( $params ) {
  49                 return 'public';
  50         }
  51
  52         public function executeGenerator( $resultPageSet ) {
  53                 $this->run( $resultPageSet );
  54         }
  55
  56         private function run( $resultPageSet = null ) {
  57                 $db = $this->getDB();
  58                 $params = $this->extractRequestParams();
  59
  60                 $this->addTables( 'category' );
  61                 $this->addFields( 'cat_title' );
  62
  63                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
  64                 $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
  65                 $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) );
  66                 $this->addWhereRange( 'cat_title', $dir, $from, $to );
  67
  68                 if ( isset( $params['prefix'] ) ) {
  69                         $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
  70                 }
  71
  72                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  73                 $this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ? ' DESC' : '' ) );
  74
  75                 $prop = array_flip( $params['prop'] );
  76                 $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
  77                 if ( isset( $prop['hidden'] ) ) {
  78                         $this->addTables( array( 'page', 'page_props' ) );
  79                         $this->addJoinConds( array(
  80                                 'page' => array( 'LEFT JOIN', array(
  81                                         'page_namespace' => NS_CATEGORY,
  82                                         'page_title=cat_title' ) ),
  83                                 'page_props' => array( 'LEFT JOIN', array(
  84                                         'pp_page=page_id',
  85                                         'pp_propname' => 'hiddencat' ) ),
  86                         ) );
  87                         $this->addFields( 'pp_propname AS cat_hidden' );
  88                 }
  89
  90                 $res = $this->select( __METHOD__ );
  91
  92                 $pages = array();
  93
  94                 $result = $this->getResult();
  95                 $count = 0;
  96                 foreach ( $res as $row ) {
  97                         if ( ++ $count > $params['limit'] ) {
  98                                 // We've reached the one extra which shows that there are additional cats to be had. Stop here...
  99                                 // TODO: Security issue - if the user has no right to view next title, it will still be shown
 100                                 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) );
 101                                 break;
 102                         }
 103
 104                         // Normalize titles
 105                         $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
 106                         if ( !is_null( $resultPageSet ) ) {
 107                                 $pages[] = $titleObj->getPrefixedText();
 108                         } else {
 109                                 $item = array();
 110                                 $result->setContent( $item, $titleObj->getText() );
 111                                 if ( isset( $prop['size'] ) ) {
 112                                         $item['size'] = intval( $row->cat_pages );
 113                                         $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files;
 114                                         $item['files'] = intval( $row->cat_files );
 115                                         $item['subcats'] = intval( $row->cat_subcats );
 116                                 }
 117                                 if ( isset( $prop['hidden'] ) && $row->cat_hidden ) {
 118                                         $item['hidden'] = '';
 119                                 }
 120                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
 121                                 if ( !$fit ) {
 122                                         $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) );
 123                                         break;
 124                                 }
 125                         }
 126                 }
 127
 128                 if ( is_null( $resultPageSet ) ) {
 129                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
 130                 } else {
 131                         $resultPageSet->populateFromTitles( $pages );
 132                 }
 133         }
 134
 135         public function getAllowedParams() {
 136                 return array(
 137                         'from' => null,
 138                         'to' => null,
 139                         'prefix' => null,
 140                         'dir' => array(
 141                                 ApiBase::PARAM_DFLT => 'ascending',
 142                                 ApiBase::PARAM_TYPE => array(
 143                                         'ascending',
 144                                         'descending'
 145                                 ),
 146                         ),
 147                         'limit' => array(
 148                                 ApiBase::PARAM_DFLT => 10,
 149                                 ApiBase::PARAM_TYPE => 'limit',
 150                                 ApiBase::PARAM_MIN => 1,
 151                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 152                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 153                         ),
 154                         'prop' => array(
 155                                 ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
 156                                 ApiBase::PARAM_DFLT => '',
 157                                 ApiBase::PARAM_ISMULTI => true
 158                         ),
 159                 );
 160         }
 161
 162         public function getParamDescription() {
 163                 return array(
 164                         'from' => 'The category to start enumerating from',
 165                         'to' => 'The category to stop enumerating at',
 166                         'prefix' => 'Search for all category titles that begin with this value',
 167                         'dir' => 'Direction to sort in',
 168                         'limit' => 'How many categories to return',
 169                         'prop' => array(
 170                                 'Which properties to get',
 171                                 ' size    - Adds number of pages in the category',
 172                                 ' hidden  - Tags categories that are hidden with __HIDDENCAT__',
 173                         ),
 174                 );
 175         }
 176
 177         public function getDescription() {
 178                 return 'Enumerate all categories';
 179         }
 180
 181         protected function getExamples() {
 182                 return array(
 183                         'api.php?action=query&list=allcategories&acprop=size',
 184                         'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
 185                 );
 186         }
 187
 188         public function getVersion() {
 189                 return __CLASS__ . ': $Id$';
 190         }
 191 }