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