includes/api/ApiQueryCategories.php

   1 <?php
   2
   3 /**
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once( "ApiQueryBase.php" );
  29 }
  30
  31 /**
  32  * A query module to enumerate categories the set of pages belong to.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryCategories extends ApiQueryGeneratorBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent::__construct( $query, $moduleName, 'cl' );
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator( $resultPageSet ) {
  47                 $this->run( $resultPageSet );
  48         }
  49
  50         private function run( $resultPageSet = null ) {
  51                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  52                         return; // nothing to do
  53                 }
  54
  55                 $params = $this->extractRequestParams();
  56                 $prop = array_flip( (array)$params['prop'] );
  57                 $show = array_flip( (array)$params['show'] );
  58
  59                 $this->addFields( array(
  60                         'cl_from',
  61                         'cl_to'
  62                 ) );
  63
  64                 $this->addFieldsIf( 'cl_sortkey', isset( $prop['sortkey'] ) );
  65                 $this->addFieldsIf( 'cl_timestamp', isset( $prop['timestamp'] ) );
  66
  67                 $this->addTables( 'categorylinks' );
  68                 $this->addWhereFld( 'cl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  69                 if ( !is_null( $params['categories'] ) ) {
  70                         $cats = array();
  71                         foreach ( $params['categories'] as $cat ) {
  72                                 $title = Title::newFromText( $cat );
  73                                 if ( !$title || $title->getNamespace() != NS_CATEGORY ) {
  74                                         $this->setWarning( "``$cat'' is not a category" );
  75                                 } else {
  76                                         $cats[] = $title->getDBkey();
  77                                 }
  78                         }
  79                         $this->addWhereFld( 'cl_to', $cats );
  80                 }
  81
  82                 if ( !is_null( $params['continue'] ) ) {
  83                         $cont = explode( '|', $params['continue'] );
  84                         if ( count( $cont ) != 2 ) {
  85                                 $this->dieUsage( "Invalid continue param. You should pass the " .
  86                                         "original value returned by the previous query", "_badcontinue" );
  87                         }
  88                         $clfrom = intval( $cont[0] );
  89                         $clto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
  90                         $this->addWhere(
  91                                 "cl_from > $clfrom OR " .
  92                                 "(cl_from = $clfrom AND " .
  93                                 "cl_to >= '$clto')"
  94                         );
  95                 }
  96
  97                 if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) ) {
  98                         $this->dieUsageMsg( array( 'show' ) );
  99                 }
 100                 if ( isset( $show['hidden'] ) || isset( $show['!hidden'] ) || isset( $prop['hidden'] ) )
 101                 {
 102                         $this->addOption( 'STRAIGHT_JOIN' );
 103                         $this->addTables( array( 'page', 'page_props' ) );
 104                         $this->addFieldsIf( 'pp_propname', isset( $prop['hidden'] ) );
 105                         $this->addJoinConds( array(
 106                                 'page' => array( 'LEFT JOIN', array(
 107                                         'page_namespace' => NS_CATEGORY,
 108                                         'page_title = cl_to' ) ),
 109                                 'page_props' => array( 'LEFT JOIN', array(
 110                                         'pp_page=page_id',
 111                                         'pp_propname' => 'hiddencat' ) )
 112                         ) );
 113                         if ( isset( $show['hidden'] ) ) {
 114                                 $this->addWhere( array( 'pp_propname IS NOT NULL' ) );
 115                         } elseif ( isset( $show['!hidden'] ) ) {
 116                                 $this->addWhere( array( 'pp_propname IS NULL' ) );
 117                         }
 118                 }
 119
 120                 $this->addOption( 'USE INDEX', array( 'categorylinks' => 'cl_from' ) );
 121                 // Don't order by cl_from if it's constant in the WHERE clause
 122                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
 123                         $this->addOption( 'ORDER BY', 'cl_to' );
 124                 } else {
 125                         $this->addOption( 'ORDER BY', "cl_from, cl_to" );
 126                 }
 127
 128                 $db = $this->getDB();
 129                 $res = $this->select( __METHOD__ );
 130
 131                 if ( is_null( $resultPageSet ) ) {
 132                         $count = 0;
 133                         foreach ( $res as $row ) {
 134                                 if ( ++$count > $params['limit'] ) {
 135                                         // We've reached the one extra which shows that
 136                                         // there are additional pages to be had. Stop here...
 137                                         $this->setContinueEnumParameter( 'continue', $row->cl_from .
 138                                                         '|' . $this->keyToTitle( $row->cl_to ) );
 139                                         break;
 140                                 }
 141
 142                                 $title = Title::makeTitle( NS_CATEGORY, $row->cl_to );
 143                                 $vals = array();
 144                                 ApiQueryBase::addTitleInfo( $vals, $title );
 145                                 if ( isset( $prop['sortkey'] ) ) {
 146                                         $vals['sortkey'] = $row->cl_sortkey;
 147                                 }
 148                                 if ( isset( $prop['timestamp'] ) ) {
 149                                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
 150                                 }
 151                                 if ( isset( $prop['hidden'] ) && !is_null( $row->pp_propname ) ) {
 152                                         $vals['hidden'] = '';
 153                                 }
 154
 155                                 $fit = $this->addPageSubItem( $row->cl_from, $vals );
 156                                 if ( !$fit ) {
 157                                         $this->setContinueEnumParameter( 'continue', $row->cl_from .
 158                                                         '|' . $this->keyToTitle( $row->cl_to ) );
 159                                         break;
 160                                 }
 161                         }
 162                 } else {
 163                         $titles = array();
 164                         foreach ( $res as $row ) {
 165                                 if ( ++$count > $params['limit'] ) {
 166                                         // We've reached the one extra which shows that
 167                                         // there are additional pages to be had. Stop here...
 168                                         $this->setContinueEnumParameter( 'continue', $row->cl_from .
 169                                                         '|' . $this->keyToTitle( $row->cl_to ) );
 170                                         break;
 171                                 }
 172
 173                                 $titles[] = Title :: makeTitle( NS_CATEGORY, $row->cl_to );
 174                         }
 175                         $resultPageSet->populateFromTitles( $titles );
 176                 }
 177         }
 178
 179         public function getAllowedParams() {
 180                 return array(
 181                         'prop' => array(
 182                                 ApiBase::PARAM_ISMULTI => true,
 183                                 ApiBase::PARAM_TYPE => array (
 184                                         'sortkey',
 185                                         'timestamp',
 186                                         'hidden',
 187                                 )
 188                         ),
 189                         'show' => array(
 190                                 ApiBase::PARAM_ISMULTI => true,
 191                                 ApiBase::PARAM_TYPE => array(
 192                                         'hidden',
 193                                         '!hidden',
 194                                 )
 195                         ),
 196                         'limit' => array(
 197                                 ApiBase::PARAM_DFLT => 10,
 198                                 ApiBase::PARAM_TYPE => 'limit',
 199                                 ApiBase::PARAM_MIN => 1,
 200                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 201                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 202                         ),
 203                         'continue' => null,
 204                         'categories' => array(
 205                                 ApiBase::PARAM_ISMULTI => true,
 206                         ),
 207                 );
 208         }
 209
 210         public function getParamDescription() {
 211                 return array(
 212                         'prop' => array(
 213                                 'Which additional properties to get for each category',
 214                                 ' sortkey    - Adds the sortkey for the category',
 215                                 ' timestamp  - Adds timestamp of when the category was added',
 216                                 ' hidden     - Tags categories that are hidden with __HIDDENCAT__',
 217                         ),
 218                         'limit' => 'How many categories to return',
 219                         'show' => 'Which kind of categories to show',
 220                         'continue' => 'When more results are available, use this to continue',
 221                         'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
 222                 );
 223         }
 224
 225         public function getDescription() {
 226                 return 'List all categories the page(s) belong to';
 227         }
 228
 229         public function getPossibleErrors() {
 230                 return array_merge( parent::getPossibleErrors(), array(
 231                         array( 'show' ),
 232                 ) );
 233         }
 234
 235         protected function getExamples() {
 236                 return array(
 237                         'Get a list of categories [[Albert Einstein]] belongs to:',
 238                         '  api.php?action=query&prop=categories&titles=Albert%20Einstein',
 239                         'Get information about all categories used in the [[Albert Einstein]]:',
 240                         '  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info'
 241                 );
 242         }
 243
 244         public function getVersion() {
 245                 return __CLASS__ . ': $Id$';
 246         }
 247 }