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 ( !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);
  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                 {
  80                         $this->addOption('USE INDEX', 'cl_timestamp');
  81                         $this->addOption('ORDER BY', 'cl_to, cl_timestamp' . ($params['dir'] == 'desc' ? ' DESC' : ''));
  82                 }
  83                 else
  84                 {
  85                         $this->addOption('USE INDEX', 'cl_sortkey');
  86                         $this->addOption('ORDER BY', 'cl_to, cl_sortkey' . ($params['dir'] == 'desc' ? ' DESC' : '') . ', cl_from');
  87                 }
  88
  89                 $this->addWhere('cl_from=page_id');
  90                 $this->setContinuation($params['continue']);
  91                 $this->addWhereFld('cl_to', $categoryTitle->getDBkey());
  92                 $this->addWhereFld('page_namespace', $params['namespace']);
  93                 $this->addWhereRange('cl_timestamp', ($params['dir'] == 'asc' ? 'newer' : 'older'), $params['start'], $params['end']);
  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                                 $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey));
 109                                 break;
 110                         }
 111
 112                         $lastSortKey = $row->cl_sortkey;        // detect duplicate sortkeys
 113
 114                         if (is_null($resultPageSet)) {
 115                                 $vals = array();
 116                                 if ($fld_ids)
 117                                         $vals['pageid'] = intval($row->page_id);
 118                                 if ($fld_title) {
 119                                         $title = Title :: makeTitle($row->page_namespace, $row->page_title);
 120                                         $vals['ns'] = intval($title->getNamespace());
 121                                         $vals['title'] = $title->getPrefixedText();
 122                                 }
 123                                 if ($fld_sortkey)
 124                                         $vals['sortkey'] = $row->cl_sortkey;
 125                                 if ($fld_timestamp)
 126                                         $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp);
 127                                 $data[] = $vals;
 128                         } else {
 129                                 $resultPageSet->processDbRow($row);
 130                         }
 131                 }
 132                 $db->freeResult($res);
 133
 134                 if (is_null($resultPageSet)) {
 135                         $this->getResult()->setIndexedTagName($data, 'cm');
 136                         $this->getResult()->addValue('query', $this->getModuleName(), $data);
 137                 }
 138         }
 139
 140         private function getContinueStr($row, $lastSortKey) {
 141                 $ret = $row->cl_sortkey . '|';
 142                 if ($row->cl_sortkey == $lastSortKey)   // duplicate sort key, add cl_from
 143                         $ret .= $row->cl_from;
 144                 return $ret;
 145         }
 146
 147         /**
 148          * Add DB WHERE clause to continue previous query based on 'continue' parameter
 149          */
 150         private function setContinuation($continue) {
 151                 if (is_null($continue))
 152                         return; // This is not a continuation request
 153
 154                 $continueList = explode('|', $continue);
 155                 $hasError = count($continueList) != 2;
 156                 $from = 0;
 157                 if (!$hasError && strlen($continueList[1]) > 0) {
 158                         $from = intval($continueList[1]);
 159                         $hasError = ($from == 0);
 160                 }
 161
 162                 if ($hasError)
 163                         $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue");
 164
 165                 $encSortKey = $this->getDB()->addQuotes($continueList[0]);
 166                 $encFrom = $this->getDB()->addQuotes($from);
 167
 168                 if ($from != 0) {
 169                         // Duplicate sort key continue
 170                         $this->addWhere( "cl_sortkey>$encSortKey OR (cl_sortkey=$encSortKey AND cl_from>=$encFrom)" );
 171                 } else {
 172                         $this->addWhere( "cl_sortkey>=$encSortKey" );
 173                 }
 174         }
 175
 176         public function getAllowedParams() {
 177                 return array (
 178                         'title' => null,
 179                         'prop' => array (
 180                                 ApiBase :: PARAM_DFLT => 'ids|title',
 181                                 ApiBase :: PARAM_ISMULTI => true,
 182                                 ApiBase :: PARAM_TYPE => array (
 183                                         'ids',
 184                                         'title',
 185                                         'sortkey',
 186                                         'timestamp',
 187                                 )
 188                         ),
 189                         'namespace' => array (
 190                                 ApiBase :: PARAM_ISMULTI => true,
 191                                 ApiBase :: PARAM_TYPE => 'namespace',
 192                         ),
 193                         'continue' => null,
 194                         'limit' => array (
 195                                 ApiBase :: PARAM_TYPE => 'limit',
 196                                 ApiBase :: PARAM_DFLT => 10,
 197                                 ApiBase :: PARAM_MIN => 1,
 198                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 199                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 200                         ),
 201                         'sort' => array(
 202                                 ApiBase :: PARAM_DFLT => 'sortkey',
 203                                 ApiBase :: PARAM_TYPE => array(
 204                                         'sortkey',
 205                                         'timestamp'
 206                                 )
 207                         ),
 208                         'dir' => array(
 209                                 ApiBase :: PARAM_DFLT => 'asc',
 210                                 ApiBase :: PARAM_TYPE => array(
 211                                         'asc',
 212                                         'desc'
 213                                 )
 214                         ),
 215                         'start' => array(
 216                                 ApiBase :: PARAM_TYPE => 'timestamp'
 217                         ),
 218                         'end' => array(
 219                                 ApiBase :: PARAM_TYPE => 'timestamp'
 220                         )
 221                 );
 222         }
 223
 224         public function getParamDescription() {
 225                 return array (
 226                         'title' => 'Which category to enumerate (required). Must include Category: prefix',
 227                         'prop' => 'What pieces of information to include',
 228                         'namespace' => 'Only include pages in these namespaces',
 229                         'sort' => 'Property to sort by',
 230                         'dir' => 'In which direction to sort',
 231                         'start' => 'Timestamp to start listing from',
 232                         'end' => 'Timestamp to end listing at',
 233                         'continue' => 'For large categories, give the value retured from previous query',
 234                         'limit' => 'The maximum number of pages to return.',
 235                 );
 236         }
 237
 238         public function getDescription() {
 239                 return 'List all pages in a given category';
 240         }
 241
 242         protected function getExamples() {
 243                 return array (
 244                                 "Get first 10 pages in [[Category:Physics]]:",
 245                                 "  api.php?action=query&list=categorymembers&cmtitle=Category:Physics",
 246                                 "Get page info about first 10 pages in [[Category:Physics]]:",
 247                                 "  api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info",
 248                         );
 249         }
 250
 251         public function getVersion() {
 252                 return __CLASS__ . ': $Id$';
 253         }
 254 }
 255