be67dd249b196fcde918753be77e82f3260d9c3f
5 * Created on Jul 9, 2009
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 * Query module to enumerate change tags.
32 class ApiQueryTags
extends ApiQueryBase
{
34 public function __construct( ApiQuery
$query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'tg' );
38 public function execute() {
39 $params = $this->extractRequestParams();
41 $prop = array_flip( $params['prop'] );
43 $fld_displayname = isset( $prop['displayname'] );
44 $fld_description = isset( $prop['description'] );
45 $fld_hitcount = isset( $prop['hitcount'] );
46 $fld_defined = isset( $prop['defined'] );
47 $fld_source = isset( $prop['source'] );
48 $fld_active = isset( $prop['active'] );
50 $limit = $params['limit'];
51 $result = $this->getResult();
53 $softwareDefinedTags = array_fill_keys( ChangeTags
::listSoftwareDefinedTags(), 0 );
54 $explicitlyDefinedTags = array_fill_keys( ChangeTags
::listExplicitlyDefinedTags(), 0 );
55 $softwareActivatedTags = array_fill_keys( ChangeTags
::listSoftwareActivatedTags(), 0 );
57 $definedTags = array_merge( $softwareDefinedTags, $explicitlyDefinedTags );
59 # Fetch defined tags that aren't past the continuation
60 if ( $params['continue'] !== null ) {
61 $cont = $params['continue'];
62 $tags = array_filter( array_keys( $definedTags ), function ( $v ) use ( $cont ) {
65 $tags = array_fill_keys( $tags, 0 );
70 # Merge in all used tags
71 $this->addTables( 'change_tag' );
72 $this->addFields( 'ct_tag' );
73 $this->addFields( [ 'hitcount' => $fld_hitcount ?
'COUNT(*)' : '0' ] );
74 $this->addOption( 'LIMIT', $limit +
1 );
75 $this->addOption( 'GROUP BY', 'ct_tag' );
76 $this->addWhereRange( 'ct_tag', 'newer', $params['continue'], null );
77 $res = $this->select( __METHOD__
);
78 foreach ( $res as $row ) {
79 $tags[$row->ct_tag
] = (int)$row->hitcount
;
82 # Now make sure the array is sorted for proper continuation
86 foreach ( $tags as $tagName => $hitcount ) {
87 if ( ++
$count > $limit ) {
88 $this->setContinueEnumParameter( 'continue', $tagName );
93 $tag['name'] = $tagName;
95 if ( $fld_displayname ) {
96 $tag['displayname'] = ChangeTags
::tagDescription( $tagName, $this );
99 if ( $fld_description ) {
100 $msg = $this->msg( "tag-$tagName-description" );
101 $tag['description'] = $msg->exists() ?
$msg->text() : '';
104 if ( $fld_hitcount ) {
105 $tag['hitcount'] = $hitcount;
108 $isSoftware = isset( $softwareDefinedTags[$tagName] );
109 $isExplicit = isset( $explicitlyDefinedTags[$tagName] );
111 if ( $fld_defined ) {
112 $tag['defined'] = $isSoftware ||
$isExplicit;
118 // TODO: Can we change this to 'software'?
119 $tag['source'][] = 'extension';
122 $tag['source'][] = 'manual';
127 $tag['active'] = $isExplicit ||
isset( $softwareActivatedTags[$tagName] );
130 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $tag );
132 $this->setContinueEnumParameter( 'continue', $tagName );
137 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'tag' );
140 public function getCacheMode( $params ) {
144 public function getAllowedParams() {
147 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
150 ApiBase
::PARAM_DFLT
=> 10,
151 ApiBase
::PARAM_TYPE
=> 'limit',
152 ApiBase
::PARAM_MIN
=> 1,
153 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
154 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
157 ApiBase
::PARAM_DFLT
=> 'name',
158 ApiBase
::PARAM_TYPE
=> [
167 ApiBase
::PARAM_ISMULTI
=> true,
168 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
173 protected function getExamplesMessages() {
175 'action=query&list=tags&tgprop=displayname|description|hitcount|defined'
176 => 'apihelp-query+tags-example-simple',
180 public function getHelpUrls() {
181 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tags';