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->addTables('category');
 100                         $this->addWhere(array(  'cl_to = cat_title',
 101                                                 'cat_hidden' => isset($show['hidden'])));
 102                 }
 103
 104                 # Don't order by cl_from if it's constant in the WHERE clause
 105                 if(count($this->getPageSet()->getGoodTitles()) == 1)
 106                         $this->addOption('ORDER BY', 'cl_to');
 107                 else
 108                         $this->addOption('ORDER BY', "cl_from, cl_to");
 109
 110                 $db = $this->getDB();
 111                 $res = $this->select(__METHOD__);
 112
 113                 if (is_null($resultPageSet)) {
 114
 115                         $data = array();
 116                         $lastId = 0;    // database has no ID 0
 117                         $count = 0;
 118                         while ($row = $db->fetchObject($res)) {
 119                                 if (++$count > $params['limit']) {
 120                                         // We've reached the one extra which shows that
 121                                         // there are additional pages to be had. Stop here...
 122                                         $this->setContinueEnumParameter('continue', $row->cl_from .
 123                                                         '|' . $this->keyToTitle($row->cl_to));
 124                                         break;
 125                                 }
 126                                 if ($lastId != $row->cl_from) {
 127                                         if($lastId != 0) {
 128                                                 $this->addPageSubItems($lastId, $data);
 129                                                 $data = array();
 130                                         }
 131                                         $lastId = $row->cl_from;
 132                                 }
 133
 134                                 $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
 135
 136                                 $vals = array();
 137                                 ApiQueryBase :: addTitleInfo($vals, $title);
 138                                 if ($fld_sortkey)
 139                                         $vals['sortkey'] = $row->cl_sortkey;
 140                                 if ($fld_timestamp)
 141                                         $vals['timestamp'] = $row->cl_timestamp;
 142
 143                                 $data[] = $vals;
 144                         }
 145
 146                         if($lastId != 0) {
 147                                 $this->addPageSubItems($lastId, $data);
 148                         }
 149
 150                 } else {
 151
 152                         $titles = array();
 153                         while ($row = $db->fetchObject($res)) {
 154                                 if (++$count > $params['limit']) {
 155                                         // We've reached the one extra which shows that
 156                                         // there are additional pages to be had. Stop here...
 157                                         $this->setContinueEnumParameter('continue', $row->cl_from .
 158                                                         '|' . $this->keyToTitle($row->cl_to));
 159                                         break;
 160                                 }
 161
 162                                 $titles[] = Title :: makeTitle(NS_CATEGORY, $row->cl_to);
 163                         }
 164                         $resultPageSet->populateFromTitles($titles);
 165                 }
 166
 167                 $db->freeResult($res);
 168         }
 169
 170         public function getAllowedParams() {
 171                 return array (
 172                         'prop' => array (
 173                                 ApiBase :: PARAM_ISMULTI => true,
 174                                 ApiBase :: PARAM_TYPE => array (
 175                                         'sortkey',
 176                                         'timestamp',
 177                                 )
 178                         ),
 179                         'show' => array(
 180                                 ApiBase :: PARAM_ISMULTI => true,
 181                                 ApiBase :: PARAM_TYPE => array(
 182                                         'hidden',
 183                                         '!hidden',
 184                                 )
 185                         ),
 186                         'limit' => array(
 187                                 ApiBase :: PARAM_DFLT => 10,
 188                                 ApiBase :: PARAM_TYPE => 'limit',
 189                                 ApiBase :: PARAM_MIN => 1,
 190                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 191                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 192                         ),
 193                         'continue' => null,
 194                 );
 195         }
 196
 197         public function getParamDescription() {
 198                 return array (
 199                         'prop' => 'Which additional properties to get for each category.',
 200                         'limit' => 'How many categories to return',
 201                         'show' => 'Which kind of categories to show',
 202                         'continue' => 'When more results are available, use this to continue',
 203                 );
 204         }
 205
 206         public function getDescription() {
 207                 return 'List all categories the page(s) belong to';
 208         }
 209
 210         protected function getExamples() {
 211                 return array (
 212                                 "Get a list of categories [[Albert Einstein]] belongs to:",
 213                                 "  api.php?action=query&prop=categories&titles=Albert%20Einstein",
 214                                 "Get information about all categories used in the [[Albert Einstein]]:",
 215                                 "  api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info"
 216                         );
 217         }
 218
 219         public function getVersion() {
 220                 return __CLASS__ . ': $Id$';
 221         }
 222 }