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['continue'])) {
  85                         $cont = explode('|', $params['continue']);
  86                         if(count($cont) != 2)
  87                                 $this->dieUsage("Invalid continue param. You should pass the " .
  88                                         "original value returned by the previous query", "_badcontinue");
  89                         $clfrom = intval($cont[0]);
  90                         $clto = $this->getDB()->strencode($this->titleToKey($cont[1]));
  91                         $this->addWhere("cl_from > $clfrom OR ".
  92                                         "(cl_from = $clfrom AND ".
  93                                         "cl_to >= '$clto')");
  94                 }
  95                 if(isset($show['hidden']) && isset($show['!hidden']))
  96                         $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show');
  97                 if(isset($show['hidden']) || isset($show['!hidden']))
  98                 {
  99                         $this->addOption('STRAIGHT_JOIN');
 100                         $this->addTables(array('page', 'page_props'));
 101                         $this->addJoinConds(array(
 102                                 'page' => array('LEFT JOIN', array(
 103                                         'page_namespace' => NS_CATEGORY,
 104                                         'page_title = cl_to')),
 105                                 'page_props' => array('LEFT JOIN', array(
 106                                         'pp_page=page_id',
 107                                         'pp_propname' => 'hiddencat'))
 108                         ));
 109                         if(isset($show['hidden']))
 110                                 $this->addWhere(array('pp_propname IS NOT NULL'));
 111                         else
 112                                 $this->addWhere(array('pp_propname IS NULL'));
 113                 }
 114
 115                 # Don't order by cl_from if it's constant in the WHERE clause
 116                 if(count($this->getPageSet()->getGoodTitles()) == 1)
 117                         $this->addOption('ORDER BY', 'cl_to');
 118                 else
 119                         $this->addOption('ORDER BY', "cl_from, cl_to");
 120
 121                 $db = $this->getDB();
 122                 $res = $this->select(__METHOD__);
 123
 124                 if (is_null($resultPageSet)) {
 125
 126                         $data = array();
 127                         $lastId = 0;    // database has no ID 0
 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                                 if ($lastId != $row->cl_from) {
 138                                         if($lastId != 0) {
 139                                                 $this->addPageSubItems($lastId, $data);
 140                                                 $data = array();
 141                                         }
 142                                         $lastId = $row->cl_from;
 143                                 }
 144
 145                                 $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
 146
 147                                 $vals = array();
 148                                 ApiQueryBase :: addTitleInfo($vals, $title);
 149                                 if ($fld_sortkey)
 150                                         $vals['sortkey'] = $row->cl_sortkey;
 151                                 if ($fld_timestamp)
 152                                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
 153
 154                                 $data[] = $vals;
 155                         }
 156
 157                         if($lastId != 0) {
 158                                 $this->addPageSubItems($lastId, $data);
 159                         }
 160
 161                 } else {
 162
 163                         $titles = array();
 164                         while ($row = $db->fetchObject($res)) {
 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                 $db->freeResult($res);
 179         }
 180
 181         public function getAllowedParams() {
 182                 return array (
 183                         'prop' => array (
 184                                 ApiBase :: PARAM_ISMULTI => true,
 185                                 ApiBase :: PARAM_TYPE => array (
 186                                         'sortkey',
 187                                         'timestamp',
 188                                 )
 189                         ),
 190                         'show' => array(
 191                                 ApiBase :: PARAM_ISMULTI => true,
 192                                 ApiBase :: PARAM_TYPE => array(
 193                                         'hidden',
 194                                         '!hidden',
 195                                 )
 196                         ),
 197                         'limit' => array(
 198                                 ApiBase :: PARAM_DFLT => 10,
 199                                 ApiBase :: PARAM_TYPE => 'limit',
 200                                 ApiBase :: PARAM_MIN => 1,
 201                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 202                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 203                         ),
 204                         'continue' => null,
 205                 );
 206         }
 207
 208         public function getParamDescription() {
 209                 return array (
 210                         'prop' => 'Which additional properties to get for each category.',
 211                         'limit' => 'How many categories to return',
 212                         'show' => 'Which kind of categories to show',
 213                         'continue' => 'When more results are available, use this to continue',
 214                 );
 215         }
 216
 217         public function getDescription() {
 218                 return 'List all categories the page(s) belong to';
 219         }
 220
 221         protected function getExamples() {
 222                 return array (
 223                                 "Get a list of categories [[Albert Einstein]] belongs to:",
 224                                 "  api.php?action=query&prop=categories&titles=Albert%20Einstein",
 225                                 "Get information about all categories used in the [[Albert Einstein]]:",
 226                                 "  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
 227                         );
 228         }
 229
 230         public function getVersion() {
 231                 return __CLASS__ . ': $Id$';
 232         }
 233 }