Remove unused variable in ProfilerMwprof
[mediawiki.git] / includes / api / ApiQueryCategories.php
blob1926dd0946cc30711f0aff6ad89dfc4684308888
1 <?php
2 /**
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
24 * @file
27 /**
28 * A query module to enumerate categories the set of pages belong to.
30 * @ingroup API
32 class ApiQueryCategories extends ApiQueryGeneratorBase {
34 public function __construct( ApiQuery $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'cl' );
38 public function execute() {
39 $this->run();
42 public function getCacheMode( $params ) {
43 return 'public';
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 /**
51 * @param ApiPageSet $resultPageSet
53 private function run( $resultPageSet = null ) {
54 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
55 return; // nothing to do
58 $params = $this->extractRequestParams();
59 $prop = array_flip( (array)$params['prop'] );
60 $show = array_flip( (array)$params['show'] );
62 $this->addFields( array(
63 'cl_from',
64 'cl_to'
65 ) );
67 $this->addFieldsIf( array( 'cl_sortkey', 'cl_sortkey_prefix' ), isset( $prop['sortkey'] ) );
68 $this->addFieldsIf( 'cl_timestamp', isset( $prop['timestamp'] ) );
70 $this->addTables( 'categorylinks' );
71 $this->addWhereFld( 'cl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
72 if ( !is_null( $params['categories'] ) ) {
73 $cats = array();
74 foreach ( $params['categories'] as $cat ) {
75 $title = Title::newFromText( $cat );
76 if ( !$title || $title->getNamespace() != NS_CATEGORY ) {
77 $this->setWarning( "\"$cat\" is not a category" );
78 } else {
79 $cats[] = $title->getDBkey();
82 $this->addWhereFld( 'cl_to', $cats );
85 if ( !is_null( $params['continue'] ) ) {
86 $cont = explode( '|', $params['continue'] );
87 $this->dieContinueUsageIf( count( $cont ) != 2 );
88 $op = $params['dir'] == 'descending' ? '<' : '>';
89 $clfrom = intval( $cont[0] );
90 $clto = $this->getDB()->addQuotes( $cont[1] );
91 $this->addWhere(
92 "cl_from $op $clfrom OR " .
93 "(cl_from = $clfrom AND " .
94 "cl_to $op= $clto)"
98 if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) ) {
99 $this->dieUsageMsg( 'show' );
101 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(
110 'pp_page=page_id',
111 'pp_propname' => 'hiddencat' ) )
112 ) );
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' ) );
122 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
123 // Don't order by cl_from if it's constant in the WHERE clause
124 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
125 $this->addOption( 'ORDER BY', 'cl_to' . $sort );
126 } else {
127 $this->addOption( 'ORDER BY', array(
128 'cl_from' . $sort,
129 'cl_to' . $sort
130 ) );
133 $res = $this->select( __METHOD__ );
135 $count = 0;
136 if ( is_null( $resultPageSet ) ) {
137 foreach ( $res as $row ) {
138 if ( ++$count > $params['limit'] ) {
139 // We've reached the one extra which shows that
140 // there are additional pages to be had. Stop here...
141 $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
142 break;
145 $title = Title::makeTitle( NS_CATEGORY, $row->cl_to );
146 $vals = array();
147 ApiQueryBase::addTitleInfo( $vals, $title );
148 if ( isset( $prop['sortkey'] ) ) {
149 $vals['sortkey'] = bin2hex( $row->cl_sortkey );
150 $vals['sortkeyprefix'] = $row->cl_sortkey_prefix;
152 if ( isset( $prop['timestamp'] ) ) {
153 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp );
155 if ( isset( $prop['hidden'] ) && !is_null( $row->pp_propname ) ) {
156 $vals['hidden'] = '';
159 $fit = $this->addPageSubItem( $row->cl_from, $vals );
160 if ( !$fit ) {
161 $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
162 break;
165 } else {
166 $titles = array();
167 foreach ( $res as $row ) {
168 if ( ++$count > $params['limit'] ) {
169 // We've reached the one extra which shows that
170 // there are additional pages to be had. Stop here...
171 $this->setContinueEnumParameter( 'continue', $row->cl_from . '|' . $row->cl_to );
172 break;
175 $titles[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
177 $resultPageSet->populateFromTitles( $titles );
181 public function getAllowedParams() {
182 return array(
183 'prop' => array(
184 ApiBase::PARAM_ISMULTI => true,
185 ApiBase::PARAM_TYPE => array(
186 'sortkey',
187 'timestamp',
188 'hidden',
191 'show' => array(
192 ApiBase::PARAM_ISMULTI => true,
193 ApiBase::PARAM_TYPE => array(
194 'hidden',
195 '!hidden',
198 'limit' => 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
205 'continue' => null,
206 'categories' => array(
207 ApiBase::PARAM_ISMULTI => true,
209 'dir' => array(
210 ApiBase::PARAM_DFLT => 'ascending',
211 ApiBase::PARAM_TYPE => array(
212 'ascending',
213 'descending'
219 public function getParamDescription() {
220 return array(
221 'prop' => array(
222 'Which additional properties to get for each category',
223 ' sortkey - Adds the sortkey (hexadecimal string) and sortkey prefix',
224 ' (human-readable part) for the category',
225 ' timestamp - Adds timestamp of when the category was added',
226 ' hidden - Tags categories that are hidden with __HIDDENCAT__',
228 'limit' => 'How many categories to return',
229 'show' => 'Which kind of categories to show',
230 'continue' => 'When more results are available, use this to continue',
231 'categories' => 'Only list these categories. Useful for checking ' .
232 'whether a certain page is in a certain category',
233 'dir' => 'The direction in which to list',
237 public function getDescription() {
238 return 'List all categories the page(s) belong to.';
241 public function getExamples() {
242 return array(
243 'api.php?action=query&prop=categories&titles=Albert%20Einstein'
244 => 'Get a list of categories [[Albert Einstein]] belongs to',
245 'api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info'
246 => 'Get information about all categories used in the [[Albert Einstein]]',
250 public function getHelpUrls() {
251 return 'https://www.mediawiki.org/wiki/API:Properties#categories_.2F_cl';