includes/api/ApiQueryCategories.php

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