includes/api/ApiQueryCategories.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
  52                 if ( $this->getPageSet()->getGoodTitleCount() == 0 )
  53                         return; // nothing to do
  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                 {
  71                         $cats = array();
  72                         foreach ( $params['categories'] as $cat )
  73                         {
  74                                 $title = Title::newFromText( $cat );
  75                                 if ( !$title || $title->getNamespace() != NS_CATEGORY )
  76                                         $this->setWarning( "``$cat'' is not a category" );
  77                                 else
  78                                         $cats[] = $title->getDBkey();
  79                         }
  80                         $this->addWhereFld( 'cl_to', $cats );
  81                 }
  82
  83                 if ( !is_null( $params['continue'] ) ) {
  84                         $cont = explode( '|', $params['continue'] );
  85                         if ( count( $cont ) != 2 )
  86                                 $this->dieUsage( "Invalid continue param. You should pass the " .
  87                                         "original value returned by the previous query", "_badcontinue" );
  88                         $clfrom = intval( $cont[0] );
  89                         $clto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
  90                         $this->addWhere( "cl_from > $clfrom OR " .
  91                                         "(cl_from = $clfrom AND " .
  92                                         "cl_to >= '$clto')" );
  93                 }
  94
  95                 if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) )
  96                         $this->dieUsageMsg( array( 'show' ) );
  97                 if ( isset( $show['hidden'] ) || isset( $show['!hidden'] ) || isset( $prop['hidden'] ) )
  98                 {
  99                         $this->addOption( 'STRAIGHT_JOIN' );
 100                         $this->addTables( array( 'page', 'page_props' ) );
 101                         $this->addFieldsIf( 'pp_propname', isset( $prop['hidden'] ) );
 102                         $this->addJoinConds( array(
 103                                 'page' => array( 'LEFT JOIN', array(
 104                                         'page_namespace' => NS_CATEGORY,
 105                                         'page_title = cl_to' ) ),
 106                                 'page_props' => array( 'LEFT JOIN', array(
 107                                         'pp_page=page_id',
 108                                         'pp_propname' => 'hiddencat' ) )
 109                         ) );
 110                         if ( isset( $show['hidden'] ) )
 111                                 $this->addWhere( array( 'pp_propname IS NOT NULL' ) );
 112                         else if ( isset( $show['!hidden'] ) )
 113                                 $this->addWhere( array( 'pp_propname IS NULL' ) );
 114                 }
 115
 116                 $this->addOption( 'USE INDEX', array( 'categorylinks' => 'cl_from' ) );
 117                 // Don't order by cl_from if it's constant in the WHERE clause
 118                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 )
 119                         $this->addOption( 'ORDER BY', 'cl_to' );
 120                 else
 121                         $this->addOption( 'ORDER BY', "cl_from, cl_to" );
 122
 123                 $db = $this->getDB();
 124                 $res = $this->select( __METHOD__ );
 125
 126                 if ( is_null( $resultPageSet ) ) {
 127
 128                         $count = 0;
 129                         while ( $row = $db->fetchObject( $res ) ) {
 130                                 if ( ++$count > $params['limit'] ) {
 131                                         // We've reached the one extra which shows that
 132                                         // there are additional pages to be had. Stop here...
 133                                         $this->setContinueEnumParameter( 'continue', $row->cl_from .
 134                                                         '|' . $this->keyToTitle( $row->cl_to ) );
 135                                         break;
 136                                 }
 137
 138                                 $title = Title :: makeTitle( NS_CATEGORY, $row->cl_to );
 139                                 $vals = array();
 140                                 ApiQueryBase :: addTitleInfo( $vals, $title );
 141                                 if ( isset( $prop['sortkey'] ) )
 142                                         $vals['sortkey'] = $row->cl_sortkey;
 143                                 if ( isset( $prop['timestamp'] ) )
 144                                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
 145                                 if ( isset( $prop['hidden'] ) && !is_null( $row->pp_propname ) )
 146                                         $vals['hidden'] = '';
 147
 148                                 $fit = $this->addPageSubItem( $row->cl_from, $vals );
 149                                 if ( !$fit )
 150                                 {
 151                                         $this->setContinueEnumParameter( 'continue', $row->cl_from .
 152                                                         '|' . $this->keyToTitle( $row->cl_to ) );
 153                                         break;
 154                                 }
 155                         }
 156                 } else {
 157
 158                         $titles = array();
 159                         while ( $row = $db->fetchObject( $res ) ) {
 160                                 if ( ++$count > $params['limit'] ) {
 161                                         // We've reached the one extra which shows that
 162                                         // there are additional pages to be had. Stop here...
 163                                         $this->setContinueEnumParameter( 'continue', $row->cl_from .
 164                                                         '|' . $this->keyToTitle( $row->cl_to ) );
 165                                         break;
 166                                 }
 167
 168                                 $titles[] = Title :: makeTitle( NS_CATEGORY, $row->cl_to );
 169                         }
 170                         $resultPageSet->populateFromTitles( $titles );
 171                 }
 172
 173                 $db->freeResult( $res );
 174         }
 175
 176         public function getAllowedParams() {
 177                 return array (
 178                         'prop' => array (
 179                                 ApiBase :: PARAM_ISMULTI => true,
 180                                 ApiBase :: PARAM_TYPE => array (
 181                                         'sortkey',
 182                                         'timestamp',
 183                                         'hidden',
 184                                 )
 185                         ),
 186                         'show' => array(
 187                                 ApiBase :: PARAM_ISMULTI => true,
 188                                 ApiBase :: PARAM_TYPE => array(
 189                                         'hidden',
 190                                         '!hidden',
 191                                 )
 192                         ),
 193                         'limit' => array(
 194                                 ApiBase :: PARAM_DFLT => 10,
 195                                 ApiBase :: PARAM_TYPE => 'limit',
 196                                 ApiBase :: PARAM_MIN => 1,
 197                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 198                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 199                         ),
 200                         'continue' => null,
 201                         'categories' => array(
 202                                 ApiBase :: PARAM_ISMULTI => true,
 203                         ),
 204                 );
 205         }
 206
 207         public function getParamDescription() {
 208                 return array (
 209                         'prop' => 'Which additional properties to get for each category.',
 210                         'limit' => 'How many categories to return',
 211                         'show' => 'Which kind of categories to show',
 212                         'continue' => 'When more results are available, use this to continue',
 213                         'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
 214                 );
 215         }
 216
 217         public function getDescription() {
 218                 return 'List all categories the page(s) belong to';
 219         }
 220
 221         public function getPossibleErrors() {
 222                 return array_merge( parent::getPossibleErrors(), array(
 223                         array( 'show' ),
 224                 ) );
 225         }
 226
 227         protected function getExamples() {
 228                 return array (
 229                                 "Get a list of categories [[Albert Einstein]] belongs to:",
 230                                 "  api.php?action=query&prop=categories&titles=Albert%20Einstein",
 231                                 "Get information about all categories used in the [[Albert Einstein]]:",
 232                                 "  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
 233                         );
 234         }
 235
 236         public function getVersion() {
 237                 return __CLASS__ . ': $Id$';
 238         }
 239 }