4 * Created on May 13, 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 * 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 categories the set of pages belong to.
36 class ApiQueryCategories
extends ApiQueryGeneratorBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'cl' );
42 public function execute() {
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 private function run( $resultPageSet = null ) {
51 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
52 return; // nothing to do
55 $params = $this->extractRequestParams();
56 $prop = array_flip( (array)$params['prop'] );
57 $show = array_flip( (array)$params['show'] );
59 $this->addFields( array(
64 $this->addFieldsIf( 'cl_sortkey', isset( $prop['sortkey'] ) );
65 $this->addFieldsIf( 'cl_timestamp', isset( $prop['timestamp'] ) );
67 $this->addTables( 'categorylinks' );
68 $this->addWhereFld( 'cl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
69 if ( !is_null( $params['categories'] ) ) {
71 foreach ( $params['categories'] as $cat ) {
72 $title = Title
::newFromText( $cat );
73 if ( !$title ||
$title->getNamespace() != NS_CATEGORY
) {
74 $this->setWarning( "``$cat'' is not a category" );
76 $cats[] = $title->getDBkey();
79 $this->addWhereFld( 'cl_to', $cats );
82 if ( !is_null( $params['continue'] ) ) {
83 $cont = explode( '|', $params['continue'] );
84 if ( count( $cont ) != 2 ) {
85 $this->dieUsage( "Invalid continue param. You should pass the " .
86 "original value returned by the previous query", "_badcontinue" );
88 $clfrom = intval( $cont[0] );
89 $clto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
91 "cl_from > $clfrom OR " .
92 "(cl_from = $clfrom AND " .
97 if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) ) {
98 $this->dieUsageMsg( array( 'show' ) );
100 if ( isset( $show['hidden'] ) ||
isset( $show['!hidden'] ) ||
isset( $prop['hidden'] ) )
102 $this->addOption( 'STRAIGHT_JOIN' );
103 $this->addTables( array( 'page', 'page_props' ) );
104 $this->addFieldsIf( 'pp_propname', isset( $prop['hidden'] ) );
105 $this->addJoinConds( array(
106 'page' => array( 'LEFT JOIN', array(
107 'page_namespace' => NS_CATEGORY
,
108 'page_title = cl_to' ) ),
109 'page_props' => array( 'LEFT JOIN', array(
111 'pp_propname' => 'hiddencat' ) )
113 if ( isset( $show['hidden'] ) ) {
114 $this->addWhere( array( 'pp_propname IS NOT NULL' ) );
115 } elseif ( isset( $show['!hidden'] ) ) {
116 $this->addWhere( array( 'pp_propname IS NULL' ) );
120 $this->addOption( 'USE INDEX', array( 'categorylinks' => 'cl_from' ) );
121 // Don't order by cl_from if it's constant in the WHERE clause
122 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
123 $this->addOption( 'ORDER BY', 'cl_to' );
125 $this->addOption( 'ORDER BY', "cl_from, cl_to" );
128 $db = $this->getDB();
129 $res = $this->select( __METHOD__
);
131 if ( is_null( $resultPageSet ) ) {
133 while ( $row = $db->fetchObject( $res ) ) {
134 if ( ++
$count > $params['limit'] ) {
135 // We've reached the one extra which shows that
136 // there are additional pages to be had. Stop here...
137 $this->setContinueEnumParameter( 'continue', $row->cl_from
.
138 '|' . $this->keyToTitle( $row->cl_to
) );
142 $title = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
144 ApiQueryBase
::addTitleInfo( $vals, $title );
145 if ( isset( $prop['sortkey'] ) ) {
146 $vals['sortkey'] = $row->cl_sortkey
;
148 if ( isset( $prop['timestamp'] ) ) {
149 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
);
151 if ( isset( $prop['hidden'] ) && !is_null( $row->pp_propname
) ) {
152 $vals['hidden'] = '';
155 $fit = $this->addPageSubItem( $row->cl_from
, $vals );
157 $this->setContinueEnumParameter( 'continue', $row->cl_from
.
158 '|' . $this->keyToTitle( $row->cl_to
) );
164 while ( $row = $db->fetchObject( $res ) ) {
165 if ( ++
$count > $params['limit'] ) {
166 // We've reached the one extra which shows that
167 // there are additional pages to be had. Stop here...
168 $this->setContinueEnumParameter( 'continue', $row->cl_from
.
169 '|' . $this->keyToTitle( $row->cl_to
) );
173 $titles[] = Title
:: makeTitle( NS_CATEGORY
, $row->cl_to
);
175 $resultPageSet->populateFromTitles( $titles );
178 $db->freeResult( $res );
181 public function getAllowedParams() {
184 ApiBase
::PARAM_ISMULTI
=> true,
185 ApiBase
::PARAM_TYPE
=> array (
192 ApiBase
::PARAM_ISMULTI
=> true,
193 ApiBase
::PARAM_TYPE
=> array(
199 ApiBase
::PARAM_DFLT
=> 10,
200 ApiBase
::PARAM_TYPE
=> 'limit',
201 ApiBase
::PARAM_MIN
=> 1,
202 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
203 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
206 'categories' => array(
207 ApiBase
::PARAM_ISMULTI
=> true,
212 public function getParamDescription() {
214 'prop' => 'Which additional properties to get for each category.',
215 'limit' => 'How many categories to return',
216 'show' => 'Which kind of categories to show',
217 'continue' => 'When more results are available, use this to continue',
218 'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
222 public function getDescription() {
223 return 'List all categories the page(s) belong to';
226 public function getPossibleErrors() {
227 return array_merge( parent
::getPossibleErrors(), array(
232 protected function getExamples() {
234 'Get a list of categories [[Albert Einstein]] belongs to:',
235 ' api.php?action=query&prop=categories&titles=Albert%20Einstein',
236 'Get information about all categories used in the [[Albert Einstein]]:',
237 ' api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info'
241 public function getVersion() {
242 return __CLASS__
. ': $Id$';