5 * Created on May 13, 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
28 * A query module to enumerate categories the set of pages belong to.
32 class ApiQueryCategories
extends ApiQueryGeneratorBase
{
34 public function __construct( $query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'cl' );
38 public function execute() {
42 public function getCacheMode( $params ) {
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
51 * @param $resultPageSet ApiPageSet
54 private function run( $resultPageSet = null ) {
55 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
56 return; // nothing to do
59 $params = $this->extractRequestParams();
60 $prop = array_flip( (array)$params['prop'] );
61 $show = array_flip( (array)$params['show'] );
63 $this->addFields( array(
68 $this->addFieldsIf( array( 'cl_sortkey', 'cl_sortkey_prefix' ), isset( $prop['sortkey'] ) );
69 $this->addFieldsIf( 'cl_timestamp', isset( $prop['timestamp'] ) );
71 $this->addTables( 'categorylinks' );
72 $this->addWhereFld( 'cl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
73 if ( !is_null( $params['categories'] ) ) {
75 foreach ( $params['categories'] as $cat ) {
76 $title = Title
::newFromText( $cat );
77 if ( !$title ||
$title->getNamespace() != NS_CATEGORY
) {
78 $this->setWarning( "\"$cat\" is not a category" );
80 $cats[] = $title->getDBkey();
83 $this->addWhereFld( 'cl_to', $cats );
86 if ( !is_null( $params['continue'] ) ) {
87 $cont = explode( '|', $params['continue'] );
88 $this->dieContinueUsageIf( count( $cont ) != 2 );
89 $op = $params['dir'] == 'descending' ?
'<' : '>';
90 $clfrom = intval( $cont[0] );
91 $clto = $this->getDB()->addQuotes( $cont[1] );
93 "cl_from $op $clfrom OR " .
94 "(cl_from = $clfrom AND " .
99 if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) ) {
100 $this->dieUsageMsg( 'show' );
102 if ( isset( $show['hidden'] ) ||
isset( $show['!hidden'] ) ||
isset( $prop['hidden'] ) )
104 $this->addOption( 'STRAIGHT_JOIN' );
105 $this->addTables( array( 'page', 'page_props' ) );
106 $this->addFieldsIf( 'pp_propname', isset( $prop['hidden'] ) );
107 $this->addJoinConds( array(
108 'page' => array( 'LEFT JOIN', array(
109 'page_namespace' => NS_CATEGORY
,
110 'page_title = cl_to' ) ),
111 'page_props' => array( 'LEFT JOIN', array(
113 'pp_propname' => 'hiddencat' ) )
115 if ( isset( $show['hidden'] ) ) {
116 $this->addWhere( array( 'pp_propname IS NOT NULL' ) );
117 } elseif ( isset( $show['!hidden'] ) ) {
118 $this->addWhere( array( 'pp_propname IS NULL' ) );
122 $this->addOption( 'USE INDEX', array( 'categorylinks' => 'cl_from' ) );
124 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
125 // Don't order by cl_from if it's constant in the WHERE clause
126 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
127 $this->addOption( 'ORDER BY', 'cl_to' . $sort );
129 $this->addOption( 'ORDER BY', array(
135 $res = $this->select( __METHOD__
);
138 if ( is_null( $resultPageSet ) ) {
139 foreach ( $res as $row ) {
140 if ( ++
$count > $params['limit'] ) {
141 // We've reached the one extra which shows that
142 // there are additional pages to be had. Stop here...
143 $this->setContinueEnumParameter( 'continue', $row->cl_from
. '|' . $row->cl_to
);
147 $title = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
149 ApiQueryBase
::addTitleInfo( $vals, $title );
150 if ( isset( $prop['sortkey'] ) ) {
151 $vals['sortkey'] = bin2hex( $row->cl_sortkey
);
152 $vals['sortkeyprefix'] = $row->cl_sortkey_prefix
;
154 if ( isset( $prop['timestamp'] ) ) {
155 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->cl_timestamp
);
157 if ( isset( $prop['hidden'] ) && !is_null( $row->pp_propname
) ) {
158 $vals['hidden'] = '';
161 $fit = $this->addPageSubItem( $row->cl_from
, $vals );
163 $this->setContinueEnumParameter( 'continue', $row->cl_from
. '|' . $row->cl_to
);
169 foreach ( $res as $row ) {
170 if ( ++
$count > $params['limit'] ) {
171 // We've reached the one extra which shows that
172 // there are additional pages to be had. Stop here...
173 $this->setContinueEnumParameter( 'continue', $row->cl_from
. '|' . $row->cl_to
);
177 $titles[] = Title
:: makeTitle( NS_CATEGORY
, $row->cl_to
);
179 $resultPageSet->populateFromTitles( $titles );
183 public function getAllowedParams() {
186 ApiBase
::PARAM_ISMULTI
=> true,
187 ApiBase
::PARAM_TYPE
=> array (
194 ApiBase
::PARAM_ISMULTI
=> true,
195 ApiBase
::PARAM_TYPE
=> array(
201 ApiBase
::PARAM_DFLT
=> 10,
202 ApiBase
::PARAM_TYPE
=> 'limit',
203 ApiBase
::PARAM_MIN
=> 1,
204 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
205 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
208 'categories' => array(
209 ApiBase
::PARAM_ISMULTI
=> true,
212 ApiBase
::PARAM_DFLT
=> 'ascending',
213 ApiBase
::PARAM_TYPE
=> array(
221 public function getParamDescription() {
224 'Which additional properties to get for each category',
225 ' sortkey - Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category',
226 ' timestamp - Adds timestamp of when the category was added',
227 ' hidden - Tags categories that are hidden with __HIDDENCAT__',
229 'limit' => 'How many categories to return',
230 'show' => 'Which kind of categories to show',
231 'continue' => 'When more results are available, use this to continue',
232 'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category',
233 'dir' => 'The direction in which to list',
237 public function getResultProperties() {
244 'sortkey' => 'string',
245 'sortkeyprefix' => 'string'
247 'timestamp' => array(
248 'timestamp' => 'timestamp'
251 'hidden' => 'boolean'
256 public function getDescription() {
257 return 'List all categories the page(s) belong to';
260 public function getPossibleErrors() {
261 return array_merge( parent
::getPossibleErrors(), array(
266 public function getExamples() {
268 'api.php?action=query&prop=categories&titles=Albert%20Einstein' => 'Get a list of categories [[Albert Einstein]] belongs to',
269 'api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info' => 'Get information about all categories used in the [[Albert Einstein]]',
273 public function getHelpUrls() {
274 return 'https://www.mediawiki.org/wiki/API:Properties#categories_.2F_cl';