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