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