5 * Created on June 14, 2007
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( "ApiQueryBase.php" );
33 * A query module to enumerate pages that belong to a category.
37 class ApiQueryCategoryMembers
extends ApiQueryGeneratorBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'cm' );
43 public function execute() {
47 public function getCacheMode( $params ) {
51 public function executeGenerator( $resultPageSet ) {
52 $this->run( $resultPageSet );
55 private function run( $resultPageSet = null ) {
56 $params = $this->extractRequestParams();
58 $this->requireOnlyOneParameter( $params, 'title', 'pageid' );
60 if ( isset( $params['title'] ) ) {
61 $categoryTitle = Title
::newFromText( $params['title'] );
63 if ( is_null( $categoryTitle ) ||
$categoryTitle->getNamespace() != NS_CATEGORY
) {
64 $this->dieUsage( 'The category name you entered is not valid', 'invalidcategory' );
66 } elseif( isset( $params['pageid'] ) ) {
67 $categoryTitle = Title
::newFromID( $params['pageid'] );
69 if ( !$categoryTitle ) {
70 $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
71 } elseif ( $categoryTitle->getNamespace() != NS_CATEGORY
) {
72 $this->dieUsage( 'The category name you entered is not valid', 'invalidcategory' );
76 $prop = array_flip( $params['prop'] );
77 $fld_ids = isset( $prop['ids'] );
78 $fld_title = isset( $prop['title'] );
79 $fld_sortkey = isset( $prop['sortkey'] );
80 $fld_sortkeyprefix = isset( $prop['sortkeyprefix'] );
81 $fld_timestamp = isset( $prop['timestamp'] );
82 $fld_type = isset( $prop['type'] );
84 if ( is_null( $resultPageSet ) ) {
85 $this->addFields( array( 'cl_from', 'page_namespace', 'page_title' ) );
86 $this->addFieldsIf( 'page_id', $fld_ids );
87 $this->addFieldsIf( 'cl_sortkey_prefix', $fld_sortkeyprefix );
88 $this->addFieldsIf( 'cl_sortkey', $fld_sortkey );
90 $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title
91 $this->addFields( array( 'cl_from', 'cl_sortkey' ) );
94 $this->addFieldsIf( 'cl_timestamp', $fld_timestamp ||
$params['sort'] == 'timestamp' );
95 $this->addFieldsIf( 'cl_type', $fld_type );
97 $this->addTables( array( 'page', 'categorylinks' ) ); // must be in this order for 'USE INDEX'
99 $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() );
100 $this->addWhereFld( 'cl_type', $params['type'] );
102 // Scanning large datasets for rare categories sucks, and I already told
103 // how to have efficient subcategory access :-) ~~~~ (oh well, domas)
106 if ( $wgMiserMode ) {
107 $miser_ns = $params['namespace'];
109 $this->addWhereFld( 'page_namespace', $params['namespace'] );
112 $dir = $params['dir'] == 'asc' ?
'newer' : 'older';
114 if ( $params['sort'] == 'timestamp' ) {
115 $this->addWhereRange( 'cl_timestamp',
120 $this->addOption( 'USE INDEX', 'cl_timestamp' );
122 $this->addOption( 'ORDER BY', 'cl_type' );
124 $this->addWhereRange( 'cl_sortkey',
126 $params['startsortkey'],
127 $params['endsortkey'] );
129 $this->addWhereRange( 'cl_from', $dir, null, null );
130 $this->addOption( 'USE INDEX', 'cl_sortkey' );
133 $this->setContinuation( $params['continue'], $params['dir'] );
135 $this->addWhere( 'cl_from=page_id' );
137 $limit = $params['limit'];
138 $this->addOption( 'LIMIT', $limit +
1 );
142 $res = $this->select( __METHOD__
);
143 foreach ( $res as $row ) {
144 if ( ++
$count > $limit ) {
145 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
146 // TODO: Security issue - if the user has no right to view next title, it will still be shown
147 if ( $params['sort'] == 'timestamp' ) {
148 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
) );
150 $this->setContinueEnumParameter( 'continue', $lastFrom );
155 // Since domas won't tell anyone what he told long ago, apply
156 // cmnamespace here. This means the query may return 0 actual
157 // results, but on the other hand it could save returning 5000
158 // useless results to the client. ~~~~
159 if ( count( $miser_ns ) && !in_array( $row->page_namespace
, $miser_ns ) ) {
163 if ( is_null( $resultPageSet ) ) {
166 $vals['pageid'] = intval( $row->page_id
);
169 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
170 ApiQueryBase
::addTitleInfo( $vals, $title );
172 if ( $fld_sortkey ) {
173 $vals['sortkey'] = $row->cl_sortkey
;
175 if ( $fld_sortkeyprefix ) {
176 $vals['sortkeyprefix'] = $row->cl_sortkey_prefix
;
179 $vals['type'] = $row->cl_type
;
181 if ( $fld_timestamp ) {
182 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
);
184 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ),
187 if ( $params['sort'] == 'timestamp' ) {
188 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
) );
190 $this->setContinueEnumParameter( 'continue', $lastFrom );
195 $resultPageSet->processDbRow( $row );
197 $lastFrom = $row->cl_from
; // detect duplicate sortkeys
200 if ( is_null( $resultPageSet ) ) {
201 $this->getResult()->setIndexedTagName_internal(
202 array( 'query', $this->getModuleName() ), 'cm' );
207 * Add DB WHERE clause to continue previous query based on 'continue' parameter
209 private function setContinuation( $continue, $dir ) {
210 if ( is_null( $continue ) ) {
211 return; // This is not a continuation request
214 $encFrom = $this->getDB()->addQuotes( intval( $continue ) );
216 $op = ( $dir == 'desc' ?
'<' : '>' );
218 $this->addWhere( "cl_from $op $encFrom" );
221 public function getAllowedParams() {
224 ApiBase
::PARAM_TYPE
=> 'string',
227 ApiBase
::PARAM_TYPE
=> 'integer'
230 ApiBase
::PARAM_DFLT
=> 'ids|title',
231 ApiBase
::PARAM_ISMULTI
=> true,
232 ApiBase
::PARAM_TYPE
=> array (
241 'namespace' => array (
242 ApiBase
::PARAM_ISMULTI
=> true,
243 ApiBase
::PARAM_TYPE
=> 'namespace',
246 ApiBase
::PARAM_ISMULTI
=> true,
247 ApiBase
::PARAM_DFLT
=> 'page|subcat|file',
248 ApiBase
::PARAM_TYPE
=> array(
256 ApiBase
::PARAM_TYPE
=> 'limit',
257 ApiBase
::PARAM_DFLT
=> 10,
258 ApiBase
::PARAM_MIN
=> 1,
259 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
260 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
263 ApiBase
::PARAM_DFLT
=> 'sortkey',
264 ApiBase
::PARAM_TYPE
=> array(
270 ApiBase
::PARAM_DFLT
=> 'asc',
271 ApiBase
::PARAM_TYPE
=> array(
277 ApiBase
::PARAM_TYPE
=> 'timestamp'
280 ApiBase
::PARAM_TYPE
=> 'timestamp'
282 'startsortkey' => null,
283 'endsortkey' => null,
287 public function getParamDescription() {
289 $p = $this->getModulePrefix();
291 'title' => 'Which category to enumerate (required). Must include Category: prefix. Cannot be used together with cmpageid',
292 'pageid' => 'Page ID of the category to enumerate. Cannot be used together with cmtitle',
294 'What pieces of information to include',
295 ' ids - Adds the page ID',
296 ' title - Adds the title and namespace ID of the page',
297 ' sortkey - Adds the sortkey used for the category (note, may be non human readable)',
298 ' sortkeyprefix - Adds the sortkey prefix used for the category',
299 ' type - Adds the type that the page has been categorised as',
300 ' timestamp - Adds the timestamp of when the page was included',
302 'namespace' => 'Only include pages in these namespaces',
303 'type' => 'What type of category members to include',
304 'sort' => 'Property to sort by',
305 'dir' => 'In which direction to sort',
306 'start' => "Timestamp to start listing from. Can only be used with {$p}sort=timestamp",
307 'end' => "Timestamp to end listing at. Can only be used with {$p}sort=timestamp",
308 'startsortkey' => "Sortkey to start listing from. Can only be used with {$p}sort=sortkey",
309 'endsortkey' => "Sortkey to end listing at. Can only be used with {$p}sort=sortkey",
310 'continue' => 'For large categories, give the value retured from previous query',
311 'limit' => 'The maximum number of pages to return.',
313 if ( $wgMiserMode ) {
314 $desc['namespace'] = array(
316 'NOTE: Due to $wgMiserMode, using this may result in fewer than "limit" results',
317 'returned before continuing; in extreme cases, zero results may be returned',
323 public function getDescription() {
324 return 'List all pages in a given category';
327 public function getPossibleErrors() {
328 return array_merge( parent
::getPossibleErrors(), array(
329 array( 'code' => 'cmmissingparam', 'info' => 'One of the parameters title, pageid is required' ),
330 array( 'code' => 'cminvalidparammix', 'info' => 'The parameters title, pageid can not be used together' ),
331 array( 'code' => 'invalidcategory', 'info' => 'The category name you entered is not valid' ),
332 array( 'code' => 'badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
333 array( 'nosuchpageid', 'pageid' ),
337 protected function getExamples() {
339 'Get first 10 pages in [[Category:Physics]]:',
340 ' api.php?action=query&list=categorymembers&cmtitle=Category:Physics',
341 'Get page info about first 10 pages in [[Category:Physics]]:',
342 ' api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info',
346 public function getVersion() {
347 return __CLASS__
. ': $Id$';