4 * Created on June 14, 2007
6 * API for MediaWiki 1.8+
8 * Copyright © 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 ) {
51 $params = $this->extractRequestParams();
53 if ( !isset( $params['title'] ) ||
is_null( $params['title'] ) ) {
54 $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' );
62 $prop = array_flip( $params['prop'] );
63 $fld_ids = isset( $prop['ids'] );
64 $fld_title = isset( $prop['title'] );
65 $fld_sortkey = isset( $prop['sortkey'] );
66 $fld_timestamp = isset( $prop['timestamp'] );
68 if ( is_null( $resultPageSet ) ) {
69 $this->addFields( array( 'cl_from', 'cl_sortkey', 'page_namespace', 'page_title' ) );
70 $this->addFieldsIf( 'page_id', $fld_ids );
72 $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title
73 $this->addFields( array( 'cl_from', 'cl_sortkey' ) );
76 $this->addFieldsIf( 'cl_timestamp', $fld_timestamp ||
$params['sort'] == 'timestamp' );
77 $this->addTables( array( 'page', 'categorylinks' ) ); // must be in this order for 'USE INDEX'
78 // Not needed after bug 10280 is applied to servers
79 if ( $params['sort'] == 'timestamp' ) {
80 $this->addOption( 'USE INDEX', 'cl_timestamp' );
82 $this->addOption( 'USE INDEX', 'cl_sortkey' );
85 $this->addWhere( 'cl_from=page_id' );
86 $this->setContinuation( $params['continue'], $params['dir'] );
87 $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() );
88 // Scanning large datasets for rare categories sucks, and I already told
89 // how to have efficient subcategory access :-) ~~~~ (oh well, domas)
93 $miser_ns = $params['namespace'];
95 $this->addWhereFld( 'page_namespace', $params['namespace'] );
97 if ( $params['sort'] == 'timestamp' ) {
98 $this->addWhereRange( 'cl_timestamp', ( $params['dir'] == 'asc' ?
'newer' : 'older' ), $params['start'], $params['end'] );
100 $this->addWhereRange( 'cl_sortkey', ( $params['dir'] == 'asc' ?
'newer' : 'older' ), $params['startsortkey'], $params['endsortkey'] );
101 $this->addWhereRange( 'cl_from', ( $params['dir'] == 'asc' ?
'newer' : 'older' ), null, null );
104 $limit = $params['limit'];
105 $this->addOption( 'LIMIT', $limit +
1 );
109 $res = $this->select( __METHOD__
);
110 foreach ( $res as $row ) {
111 if ( ++
$count > $limit ) {
112 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
113 // TODO: Security issue - if the user has no right to view next title, it will still be shown
114 if ( $params['sort'] == 'timestamp' ) {
115 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
) );
117 $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) );
122 // Since domas won't tell anyone what he told long ago, apply
123 // cmnamespace here. This means the query may return 0 actual
124 // results, but on the other hand it could save returning 5000
125 // useless results to the client. ~~~~
126 if ( count( $miser_ns ) && !in_array( $row->page_namespace
, $miser_ns ) ) {
130 if ( is_null( $resultPageSet ) ) {
133 $vals['pageid'] = intval( $row->page_id
);
136 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
137 ApiQueryBase
::addTitleInfo( $vals, $title );
139 if ( $fld_sortkey ) {
140 $vals['sortkey'] = $row->cl_sortkey
;
142 if ( $fld_timestamp ) {
143 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
);
145 $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ),
148 if ( $params['sort'] == 'timestamp' ) {
149 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
) );
151 $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) );
156 $resultPageSet->processDbRow( $row );
158 $lastSortKey = $row->cl_sortkey
; // detect duplicate sortkeys
161 if ( is_null( $resultPageSet ) ) {
162 $this->getResult()->setIndexedTagName_internal(
163 array( 'query', $this->getModuleName() ), 'cm' );
167 private function getContinueStr( $row, $lastSortKey ) {
168 $ret = $row->cl_sortkey
. '|';
169 if ( $row->cl_sortkey
== $lastSortKey ) { // duplicate sort key, add cl_from
170 $ret .= $row->cl_from
;
176 * Add DB WHERE clause to continue previous query based on 'continue' parameter
178 private function setContinuation( $continue, $dir ) {
179 if ( is_null( $continue ) ) {
180 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' );
192 $encSortKey = $this->getDB()->addQuotes( $sortkey );
193 $encFrom = $this->getDB()->addQuotes( $from );
195 $op = ( $dir == 'desc' ?
'<' : '>' );
198 // Duplicate sort key continue
199 $this->addWhere( "cl_sortkey$op$encSortKey OR (cl_sortkey=$encSortKey AND cl_from$op=$encFrom)" );
201 $this->addWhere( "cl_sortkey$op=$encSortKey" );
205 public function getAllowedParams() {
209 ApiBase
::PARAM_DFLT
=> 'ids|title',
210 ApiBase
::PARAM_ISMULTI
=> true,
211 ApiBase
::PARAM_TYPE
=> array (
218 'namespace' => array (
219 ApiBase
::PARAM_ISMULTI
=> true,
220 ApiBase
::PARAM_TYPE
=> 'namespace',
224 ApiBase
::PARAM_TYPE
=> 'limit',
225 ApiBase
::PARAM_DFLT
=> 10,
226 ApiBase
::PARAM_MIN
=> 1,
227 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
228 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
231 ApiBase
::PARAM_DFLT
=> 'sortkey',
232 ApiBase
::PARAM_TYPE
=> array(
238 ApiBase
::PARAM_DFLT
=> 'asc',
239 ApiBase
::PARAM_TYPE
=> array(
245 ApiBase
::PARAM_TYPE
=> 'timestamp'
248 ApiBase
::PARAM_TYPE
=> 'timestamp'
250 'startsortkey' => null,
251 'endsortkey' => null,
255 public function getParamDescription() {
257 $p = $this->getModulePrefix();
259 'title' => 'Which category to enumerate (required). Must include Category: prefix',
261 'What pieces of information to include',
262 ' ids - Adds the page id',
263 ' title - Adds the title and namespace id of the page',
264 ' sortkey - Adds the sortkey used for the category',
265 ' timestamp - Adds the timestamp of when the page was included',
267 'namespace' => 'Only include pages in these namespaces',
268 'sort' => 'Property to sort by',
269 'dir' => 'In which direction to sort',
270 'start' => "Timestamp to start listing from. Can only be used with {$p}sort=timestamp",
271 'end' => "Timestamp to end listing at. Can only be used with {$p}sort=timestamp",
272 'startsortkey' => "Sortkey to start listing from. Can only be used with {$p}sort=sortkey",
273 'endsortkey' => "Sortkey to end listing at. Can only be used with {$p}sort=sortkey",
274 'continue' => 'For large categories, give the value retured from previous query',
275 'limit' => 'The maximum number of pages to return.',
277 if ( $wgMiserMode ) {
278 $desc['namespace'] = array(
280 'NOTE: Due to $wgMiserMode, using this may result in fewer than "limit" results',
281 'returned before continuing; in extreme cases, zero results may be returned',
287 public function getDescription() {
288 return 'List all pages in a given category';
291 public function getPossibleErrors() {
292 return array_merge( parent
::getPossibleErrors(), array(
293 array( 'code' => 'notitle', 'info' => 'The cmtitle parameter is required' ),
294 array( 'code' => 'invalidcategory', 'info' => 'The category name you entered is not valid' ),
295 array( 'code' => 'badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
299 protected function getExamples() {
301 'Get first 10 pages in [[Category:Physics]]:',
302 ' api.php?action=query&list=categorymembers&cmtitle=Category:Physics',
303 'Get page info about first 10 pages in [[Category:Physics]]:',
304 ' api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info',
308 public function getVersion() {
309 return __CLASS__
. ': $Id$';