4 * Created on June 14, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once ( "ApiQueryBase.php" );
32 * A query module to enumerate pages that belong to a category.
36 class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
38 public function __construct( $query, $moduleName ) {
39 parent :: __construct( $query, $moduleName, 'cm' );
42 public function execute() {
46 public function getCacheMode( $params ) {
50 public function executeGenerator( $resultPageSet ) {
51 $this->run( $resultPageSet );
54 private function run( $resultPageSet = null ) {
56 $params = $this->extractRequestParams();
58 if ( !isset( $params['title'] ) || is_null( $params['title'] ) )
59 $this->dieUsage( "The cmtitle parameter is required", 'notitle' );
60 $categoryTitle = Title::newFromText( $params['title'] );
62 if ( is_null( $categoryTitle ) || $categoryTitle->getNamespace() != NS_CATEGORY )
63 $this->dieUsage( "The category name you entered is not valid", 'invalidcategory' );
65 $prop = array_flip( $params['prop'] );
66 $fld_ids = isset( $prop['ids'] );
67 $fld_title = isset( $prop['title'] );
68 $fld_sortkey = isset( $prop['sortkey'] );
69 $fld_timestamp = isset( $prop['timestamp'] );
71 if ( is_null( $resultPageSet ) ) {
72 $this->addFields( array( 'cl_from', 'cl_sortkey', 'page_namespace', 'page_title' ) );
73 $this->addFieldsIf( 'page_id', $fld_ids );
75 $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title
76 $this->addFields( array( 'cl_from', 'cl_sortkey' ) );
79 $this->addFieldsIf( 'cl_timestamp', $fld_timestamp || $params['sort'] == 'timestamp' );
80 $this->addTables( array( 'page', 'categorylinks' ) ); // must be in this order for 'USE INDEX'
81 // Not needed after bug 10280 is applied to servers
82 if ( $params['sort'] == 'timestamp' )
83 $this->addOption( 'USE INDEX', 'cl_timestamp' );
85 $this->addOption( 'USE INDEX', 'cl_sortkey' );
87 $this->addWhere( 'cl_from=page_id' );
88 $this->setContinuation( $params['continue'], $params['dir'] );
89 $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() );
90 // Scanning large datasets for rare categories sucks, and I already told
91 // how to have efficient subcategory access :-) ~~~~ (oh well, domas)
95 $miser_ns = $params['namespace'];
97 $this->addWhereFld( 'page_namespace', $params['namespace'] );
99 if ( $params['sort'] == 'timestamp' )
100 $this->addWhereRange( 'cl_timestamp', ( $params['dir'] == 'asc' ? 'newer' : 'older' ), $params['start'], $params['end'] );
103 $this->addWhereRange( 'cl_sortkey', ( $params['dir'] == 'asc' ? 'newer' : 'older' ), $params['startsortkey'], $params['endsortkey'] );
104 $this->addWhereRange( 'cl_from', ( $params['dir'] == 'asc' ? 'newer' : 'older' ), null, null );
107 $limit = $params['limit'];
108 $this->addOption( 'LIMIT', $limit + 1 );
110 $db = $this->getDB();
115 $res = $this->select( __METHOD__ );
116 while ( $row = $db->fetchObject( $res ) ) {
117 if ( ++ $count > $limit ) {
118 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
119 // TODO: Security issue - if the user has no right to view next title, it will still be shown
120 if ( $params['sort'] == 'timestamp' )
121 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->cl_timestamp ) );
123 $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) );
127 // Since domas won't tell anyone what he told long ago, apply
128 // cmnamespace here. This means the query may return 0 actual
129 // results, but on the other hand it could save returning 5000
130 // useless results to the client. ~~~~
131 if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) )
134 if ( is_null( $resultPageSet ) ) {
137 $vals['pageid'] = intval( $row->page_id );
139 $title = Title :: makeTitle( $row->page_namespace, $row->page_title );
140 ApiQueryBase::addTitleInfo( $vals, $title );
143 $vals['sortkey'] = $row->cl_sortkey;
144 if ( $fld_timestamp )
145 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
146 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ),
150 if ( $params['sort'] == 'timestamp' )
151 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->cl_timestamp ) );
153 $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) );
157 $resultPageSet->processDbRow( $row );
159 $lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys
161 $db->freeResult( $res );
163 if ( is_null( $resultPageSet ) ) {
164 $this->getResult()->setIndexedTagName_internal(
165 array( 'query', $this->getModuleName() ), 'cm' );
169 private function getContinueStr( $row, $lastSortKey ) {
170 $ret = $row->cl_sortkey . '|';
171 if ( $row->cl_sortkey == $lastSortKey ) // duplicate sort key, add cl_from
172 $ret .= $row->cl_from;
177 * Add DB WHERE clause to continue previous query based on 'continue' parameter
179 private function setContinuation( $continue, $dir ) {
180 if ( is_null( $continue ) )
181 return; // This is not a continuation request
183 $pos = strrpos( $continue, '|' );
184 $sortkey = substr( $continue, 0, $pos );
185 $fromstr = substr( $continue, $pos + 1 );
186 $from = intval( $fromstr );
188 if ( $from == 0 && strlen( $fromstr ) > 0 )
189 $this->dieUsage( "Invalid continue param. You should pass the original value returned by the previous query", "badcontinue" );
191 $encSortKey = $this->getDB()->addQuotes( $sortkey );
192 $encFrom = $this->getDB()->addQuotes( $from );
194 $op = ( $dir == 'desc' ? '<' : '>' );
197 // Duplicate sort key continue
198 $this->addWhere( "cl_sortkey$op$encSortKey OR (cl_sortkey=$encSortKey AND cl_from$op=$encFrom)" );
200 $this->addWhere( "cl_sortkey$op=$encSortKey" );
204 public function getAllowedParams() {
208 ApiBase :: PARAM_DFLT => 'ids|title',
209 ApiBase :: PARAM_ISMULTI => true,
210 ApiBase :: PARAM_TYPE => array (
217 'namespace' => array (
218 ApiBase :: PARAM_ISMULTI => true,
219 ApiBase :: PARAM_TYPE => 'namespace',
223 ApiBase :: PARAM_TYPE => 'limit',
224 ApiBase :: PARAM_DFLT => 10,
225 ApiBase :: PARAM_MIN => 1,
226 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
227 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
230 ApiBase :: PARAM_DFLT => 'sortkey',
231 ApiBase :: PARAM_TYPE => array(
237 ApiBase :: PARAM_DFLT => 'asc',
238 ApiBase :: PARAM_TYPE => array(
244 ApiBase :: PARAM_TYPE => 'timestamp'
247 ApiBase :: PARAM_TYPE => 'timestamp'
249 'startsortkey' => null,
250 'endsortkey' => null,
254 public function getParamDescription() {
257 'title' => 'Which category to enumerate (required). Must include Category: prefix',
258 'prop' => 'What pieces of information to include',
259 'namespace' => 'Only include pages in these namespaces',
260 'sort' => 'Property to sort by',
261 'dir' => 'In which direction to sort',
262 'start' => 'Timestamp to start listing from. Can only be used with cmsort=timestamp',
263 'end' => 'Timestamp to end listing at. Can only be used with cmsort=timestamp',
264 'startsortkey' => 'Sortkey to start listing from. Can only be used with cmsort=sortkey',
265 'endsortkey' => 'Sortkey to end listing at. Can only be used with cmsort=sortkey',
266 'continue' => 'For large categories, give the value retured from previous query',
267 'limit' => 'The maximum number of pages to return.',
269 if ( $wgMiserMode ) {
270 $desc['namespace'] = array(
272 'NOTE: Due to $wgMiserMode, using this may result in fewer than "limit" results',
273 'returned before continuing; in extreme cases, zero results may be returned.',
279 public function getDescription() {
280 return 'List all pages in a given category';
283 public function getPossibleErrors() {
284 return array_merge( parent::getPossibleErrors(), array(
285 array( 'code' => 'notitle', 'info' => 'The cmtitle parameter is required' ),
286 array( 'code' => 'invalidcategory', 'info' => 'The category name you entered is not valid' ),
287 array( 'code' => 'badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
291 protected function getExamples() {
293 "Get first 10 pages in [[Category:Physics]]:",
294 " api.php?action=query&list=categorymembers&cmtitle=Category:Physics",
295 "Get page info about first 10 pages in [[Category:Physics]]:",
296 " api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info",
300 public function getVersion() {
301 return __CLASS__ . ': $Id: ApiQueryCategoryMembers.php 69932 2010-07-26 08:03:21Z tstarling $';