includes/api/ApiQueryCategoryMembers.php

   1 <?php
   2
   3 /*
   4  * Created on June 14, 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 pages that belong to a category.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'cm');
  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                 $params = $this->extractRequestParams();
  53
  54                 if (is_null($params['category'])) {
  55                         if (is_null($params['title']))
  56                                 $this->dieUsage("Either the cmcategory or the cmtitle parameter is required", 'notitle');
  57                         else
  58                                 $categoryTitle = Title::newFromText($params['title']);
  59                 } else if(is_null($params['title']))
  60                         $categoryTitle = Title::makeTitleSafe(NS_CATEGORY, $params['category']);
  61                 else
  62                         $this->dieUsage("The cmcategory and cmtitle parameters can't be used together", 'titleandcategory');
  63
  64                 if ( is_null( $categoryTitle ) || $categoryTitle->getNamespace() != NS_CATEGORY )
  65                         $this->dieUsage("The category name you entered is not valid", 'invalidcategory');
  66
  67                 $prop = array_flip($params['prop']);
  68                 $fld_ids = isset($prop['ids']);
  69                 $fld_title = isset($prop['title']);
  70                 $fld_sortkey = isset($prop['sortkey']);
  71                 $fld_timestamp = isset($prop['timestamp']);
  72
  73                 if (is_null($resultPageSet)) {
  74                         $this->addFields(array('cl_from', 'cl_sortkey', 'page_namespace', 'page_title'));
  75                         $this->addFieldsIf('page_id', $fld_ids);
  76                 } else {
  77                         $this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title
  78                         $this->addFields(array('cl_from', 'cl_sortkey'));
  79                 }
  80
  81                 $this->addFieldsIf('cl_timestamp', $fld_timestamp);
  82                 $this->addTables(array('page','categorylinks'));        // must be in this order for 'USE INDEX'
  83                                                                         // Not needed after bug 10280 is applied to servers
  84                 if($params['sort'] == 'timestamp')
  85                 {
  86                         $this->addOption('USE INDEX', 'cl_timestamp');
  87                         $this->addOption('ORDER BY', 'cl_to, cl_timestamp' . ($params['dir'] == 'desc' ? ' DESC' : ''));
  88                 }
  89                 else
  90                 {
  91                         $this->addOption('USE INDEX', 'cl_sortkey');
  92                         $this->addOption('ORDER BY', 'cl_to, cl_sortkey' . ($params['dir'] == 'desc' ? ' DESC' : '') . ', cl_from');
  93                 }
  94
  95                 $this->addWhere('cl_from=page_id');
  96                 $this->setContinuation($params['continue']);
  97                 $this->addWhereFld('cl_to', $categoryTitle->getDBkey());
  98                 $this->addWhereFld('page_namespace', $params['namespace']);
  99                 $this->addWhereRange('cl_timestamp', ($params['dir'] == 'asc' ? 'newer' : 'older'), $params['start'], $params['end']);
 100
 101                 $limit = $params['limit'];
 102                 $this->addOption('LIMIT', $limit +1);
 103
 104                 $db = $this->getDB();
 105
 106                 $data = array ();
 107                 $count = 0;
 108                 $lastSortKey = null;
 109                 $res = $this->select(__METHOD__);
 110                 while ($row = $db->fetchObject($res)) {
 111                         if (++ $count > $limit) {
 112                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 113                                 // TODO: Security issue - if the user has no right to view next title, it will still be shown
 114                                 $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
 115                                 break;
 116                         }
 117
 118                         $lastSortKey = $row->cl_sortkey;        // detect duplicate sortkeys
 119
 120                         if (is_null($resultPageSet)) {
 121                                 $vals = array();
 122                                 if ($fld_ids)
 123                                         $vals['pageid'] = intval($row->page_id);
 124                                 if ($fld_title) {
 125                                         $title = Title :: makeTitle($row->page_namespace, $row->page_title);
 126                                         $vals['ns'] = intval($title->getNamespace());
 127                                         $vals['title'] = $title->getPrefixedText();
 128                                 }
 129                                 if ($fld_sortkey)
 130                                         $vals['sortkey'] = $row->cl_sortkey;
 131                                 if ($fld_timestamp)
 132                                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
 133                                 $data[] = $vals;
 134                         } else {
 135                                 $resultPageSet->processDbRow($row);
 136                         }
 137                 }
 138                 $db->freeResult($res);
 139
 140                 if (is_null($resultPageSet)) {
 141                         $this->getResult()->setIndexedTagName($data, 'cm');
 142                         $this->getResult()->addValue('query', $this->getModuleName(), $data);
 143                 }
 144         }
 145
 146         private function getContinueStr($row, $lastSortKey) {
 147                 $ret = $row->cl_sortkey . '|';
 148                 if ($row->cl_sortkey == $lastSortKey)   // duplicate sort key, add cl_from
 149                         $ret .= $row->cl_from;
 150                 return $ret;
 151         }
 152
 153         /**
 154          * Add DB WHERE clause to continue previous query based on 'continue' parameter
 155          */
 156         private function setContinuation($continue) {
 157                 if (is_null($continue))
 158                         return; // This is not a continuation request
 159
 160                 $continueList = explode('|', $continue);
 161                 $hasError = count($continueList) != 2;
 162                 $from = 0;
 163                 if (!$hasError && strlen($continueList[1]) > 0) {
 164                         $from = intval($continueList[1]);
 165                         $hasError = ($from == 0);
 166                 }
 167
 168                 if ($hasError)
 169                         $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
 170
 171                 $encSortKey = $this->getDB()->addQuotes($continueList[0]);
 172                 $encFrom = $this->getDB()->addQuotes($from);
 173
 174                 if ($from != 0) {
 175                         // Duplicate sort key continue
 176                         $this->addWhere( "cl_sortkey>$encSortKey OR (cl_sortkey=$encSortKey AND cl_from>=$encFrom)" );
 177                 } else {
 178                         $this->addWhere( "cl_sortkey>=$encSortKey" );
 179                 }
 180         }
 181
 182         public function getAllowedParams() {
 183                 return array (
 184                         'title' => null,
 185                         'category' => null, // DEPRECATED, will be removed in early March
 186                         'prop' => array (
 187                                 ApiBase :: PARAM_DFLT => 'ids|title',
 188                                 ApiBase :: PARAM_ISMULTI => true,
 189                                 ApiBase :: PARAM_TYPE => array (
 190                                         'ids',
 191                                         'title',
 192                                         'sortkey',
 193                                         'timestamp',
 194                                 )
 195                         ),
 196                         'namespace' => array (
 197                                 ApiBase :: PARAM_ISMULTI => true,
 198                                 ApiBase :: PARAM_TYPE => 'namespace',
 199                         ),
 200                         'continue' => null,
 201                         'limit' => array (
 202                                 ApiBase :: PARAM_TYPE => 'limit',
 203                                 ApiBase :: PARAM_DFLT => 10,
 204                                 ApiBase :: PARAM_MIN => 1,
 205                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 206                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 207                         ),
 208                         'sort' => array(
 209                                 ApiBase :: PARAM_DFLT => 'sortkey',
 210                                 ApiBase :: PARAM_TYPE => array(
 211                                         'sortkey',
 212                                         'timestamp'
 213                                 )
 214                         ),
 215                         'dir' => array(
 216                                 ApiBase :: PARAM_DFLT => 'asc',
 217                                 ApiBase :: PARAM_TYPE => array(
 218                                         'asc',
 219                                         'desc'
 220                                 )
 221                         ),
 222                         'start' => array(
 223                                 ApiBase :: PARAM_TYPE => 'timestamp'
 224                         ),
 225                         'end' => array(
 226                                 ApiBase :: PARAM_TYPE => 'timestamp'
 227                         )
 228                 );
 229         }
 230
 231         public function getParamDescription() {
 232                 return array (
 233                         'title' => 'Which category to enumerate (required). Must include Category: prefix',
 234                         'prop' => 'What pieces of information to include',
 235                         'namespace' => 'Only include pages in these namespaces',
 236                         'sort' => 'Property to sort by',
 237                         'dir' => 'In which direction to sort',
 238                         'start' => 'Timestamp to start listing from',
 239                         'end' => 'Timestamp to end listing at',
 240                         'continue' => 'For large categories, give the value retured from previous query',
 241                         'limit' => 'The maximum number of pages to return.',
 242                         'category' => 'DEPRECATED. Like title, but without the Category: prefix.',
 243                 );
 244         }
 245
 246         public function getDescription() {
 247                 return 'List all pages in a given category';
 248         }
 249
 250         protected function getExamples() {
 251                 return array (
 252                                 "Get first 10 pages in [[Category:Physics]]:",
 253                                 "  api.php?action=query&list=categorymembers&cmtitle=Category:Physics",
 254                                 "Get page info about first 10 pages in [[Category:Physics]]:",
 255                                 "  api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info",
 256                         );
 257         }
 258
 259         public function getVersion() {
 260                 return __CLASS__ . ': $Id$';
 261         }
 262 }
 263