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 executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 private function run( $resultPageSet = null ) {
52 $params = $this->extractRequestParams();
54 if ( !isset( $params['title'] ) ||
is_null( $params['title'] ) )
55 $this->dieUsage( "The cmtitle parameter is required", 'notitle' );
56 $categoryTitle = Title
::newFromText( $params['title'] );
58 if ( is_null( $categoryTitle ) ||
$categoryTitle->getNamespace() != NS_CATEGORY
)
59 $this->dieUsage( "The category name you entered is not valid", 'invalidcategory' );
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'] );
67 if ( is_null( $resultPageSet ) ) {
68 $this->addFields( array( 'cl_from', 'cl_sortkey', 'page_namespace', 'page_title' ) );
69 $this->addFieldsIf( 'page_id', $fld_ids );
71 $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title
72 $this->addFields( array( 'cl_from', 'cl_sortkey' ) );
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' );
81 $this->addOption( 'USE INDEX', 'cl_sortkey' );
83 $this->addWhere( 'cl_from=page_id' );
84 $this->setContinuation( $params['continue'], $params['dir'] );
85 $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() );
86 // Scanning large datasets for rare categories sucks, and I already told
87 // how to have efficient subcategory access :-) ~~~~ (oh well, domas)
91 $miser_ns = $params['namespace'];
93 $this->addWhereFld( 'page_namespace', $params['namespace'] );
95 if ( $params['sort'] == 'timestamp' )
96 $this->addWhereRange( 'cl_timestamp', ( $params['dir'] == 'asc' ?
'newer' : 'older' ), $params['start'], $params['end'] );
99 $this->addWhereRange( 'cl_sortkey', ( $params['dir'] == 'asc' ?
'newer' : 'older' ), $params['startsortkey'], $params['endsortkey'] );
100 $this->addWhereRange( 'cl_from', ( $params['dir'] == 'asc' ?
'newer' : 'older' ), null, null );
103 $limit = $params['limit'];
104 $this->addOption( 'LIMIT', $limit +
1 );
106 $db = $this->getDB();
111 $res = $this->select( __METHOD__
);
112 while ( $row = $db->fetchObject( $res ) ) {
113 if ( ++
$count > $limit ) {
114 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
115 // TODO: Security issue - if the user has no right to view next title, it will still be shown
116 if ( $params['sort'] == 'timestamp' )
117 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
) );
119 $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) );
123 // Since domas won't tell anyone what he told long ago, apply
124 // cmnamespace here. This means the query may return 0 actual
125 // results, but on the other hand it could save returning 5000
126 // useless results to the client. ~~~~
127 if ( count( $miser_ns ) && !in_array( $row->page_namespace
, $miser_ns ) )
130 if ( is_null( $resultPageSet ) ) {
133 $vals['pageid'] = intval( $row->page_id
);
135 $title = Title
:: makeTitle( $row->page_namespace
, $row->page_title
);
136 ApiQueryBase
::addTitleInfo( $vals, $title );
139 $vals['sortkey'] = $row->cl_sortkey
;
140 if ( $fld_timestamp )
141 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
);
142 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ),
146 if ( $params['sort'] == 'timestamp' )
147 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
) );
149 $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) );
153 $resultPageSet->processDbRow( $row );
155 $lastSortKey = $row->cl_sortkey
; // detect duplicate sortkeys
157 $db->freeResult( $res );
159 if ( is_null( $resultPageSet ) ) {
160 $this->getResult()->setIndexedTagName_internal(
161 array( 'query', $this->getModuleName() ), 'cm' );
165 private function getContinueStr( $row, $lastSortKey ) {
166 $ret = $row->cl_sortkey
. '|';
167 if ( $row->cl_sortkey
== $lastSortKey ) // duplicate sort key, add cl_from
168 $ret .= $row->cl_from
;
173 * Add DB WHERE clause to continue previous query based on 'continue' parameter
175 private function setContinuation( $continue, $dir ) {
176 if ( is_null( $continue ) )
177 return; // This is not a continuation request
179 $pos = strrpos( $continue, '|' );
180 $sortkey = substr( $continue, 0, $pos );
181 $fromstr = substr( $continue, $pos +
1 );
182 $from = intval( $fromstr );
184 if ( $from == 0 && strlen( $fromstr ) > 0 )
185 $this->dieUsage( "Invalid continue param. You should pass the original value returned by the previous query", "badcontinue" );
187 $encSortKey = $this->getDB()->addQuotes( $sortkey );
188 $encFrom = $this->getDB()->addQuotes( $from );
190 $op = ( $dir == 'desc' ?
'<' : '>' );
193 // Duplicate sort key continue
194 $this->addWhere( "cl_sortkey$op$encSortKey OR (cl_sortkey=$encSortKey AND cl_from$op=$encFrom)" );
196 $this->addWhere( "cl_sortkey$op=$encSortKey" );
200 public function getAllowedParams() {
204 ApiBase
:: PARAM_DFLT
=> 'ids|title',
205 ApiBase
:: PARAM_ISMULTI
=> true,
206 ApiBase
:: PARAM_TYPE
=> array (
213 'namespace' => array (
214 ApiBase
:: PARAM_ISMULTI
=> true,
215 ApiBase
:: PARAM_TYPE
=> 'namespace',
219 ApiBase
:: PARAM_TYPE
=> 'limit',
220 ApiBase
:: PARAM_DFLT
=> 10,
221 ApiBase
:: PARAM_MIN
=> 1,
222 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
223 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
226 ApiBase
:: PARAM_DFLT
=> 'sortkey',
227 ApiBase
:: PARAM_TYPE
=> array(
233 ApiBase
:: PARAM_DFLT
=> 'asc',
234 ApiBase
:: PARAM_TYPE
=> array(
240 ApiBase
:: PARAM_TYPE
=> 'timestamp'
243 ApiBase
:: PARAM_TYPE
=> 'timestamp'
245 'startsortkey' => null,
246 'endsortkey' => null,
250 public function getParamDescription() {
253 'title' => 'Which category to enumerate (required). Must include Category: prefix',
254 'prop' => 'What pieces of information to include',
255 'namespace' => 'Only include pages in these namespaces',
256 'sort' => 'Property to sort by',
257 'dir' => 'In which direction to sort',
258 'start' => 'Timestamp to start listing from. Can only be used with cmsort=timestamp',
259 'end' => 'Timestamp to end listing at. Can only be used with cmsort=timestamp',
260 'startsortkey' => 'Sortkey to start listing from. Can only be used with cmsort=sortkey',
261 'endsortkey' => 'Sortkey to end listing at. Can only be used with cmsort=sortkey',
262 'continue' => 'For large categories, give the value retured from previous query',
263 'limit' => 'The maximum number of pages to return.',
265 if ( $wgMiserMode ) {
266 $desc['namespace'] = array(
268 'NOTE: Due to $wgMiserMode, using this may result in fewer than "limit" results',
269 'returned before continuing; in extreme cases, zero results may be returned.',
275 public function getDescription() {
276 return 'List all pages in a given category';
279 protected function getExamples() {
281 "Get first 10 pages in [[Category:Physics]]:",
282 " api.php?action=query&list=categorymembers&cmtitle=Category:Physics",
283 "Get page info about first 10 pages in [[Category:Physics]]:",
284 " api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info",
288 public function getVersion() {
289 return __CLASS__
. ': $Id$';