includes/api/ApiQueryTags.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Jul 9, 2009
   6  *
   7  * Copyright © 2009
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * Query module to enumerate change tags.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQueryTags extends ApiQueryBase {
  33
  34         public function __construct( ApiQuery $query, $moduleName ) {
  35                 parent::__construct( $query, $moduleName, 'tg' );
  36         }
  37
  38         public function execute() {
  39                 $params = $this->extractRequestParams();
  40
  41                 $prop = array_flip( $params['prop'] );
  42
  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'] );
  49
  50                 $limit = $params['limit'];
  51                 $result = $this->getResult();
  52
  53                 $softwareDefinedTags = array_fill_keys( ChangeTags::listSoftwareDefinedTags(), 0 );
  54                 $explicitlyDefinedTags = array_fill_keys( ChangeTags::listExplicitlyDefinedTags(), 0 );
  55                 $softwareActivatedTags = array_fill_keys( ChangeTags::listSoftwareActivatedTags(), 0 );
  56                 $tagStats = ChangeTags::tagUsageStatistics();
  57
  58                 $tagHitcounts = array_merge( $softwareDefinedTags, $explicitlyDefinedTags, $tagStats );
  59                 $tags = array_keys( $tagHitcounts );
  60
  61                 # Fetch defined tags that aren't past the continuation
  62                 if ( $params['continue'] !== null ) {
  63                         $cont = $params['continue'];
  64                         $tags = array_filter( $tags, function ( $v ) use ( $cont ) {
  65                                 return $v >= $cont;
  66                         } );
  67                 }
  68
  69                 # Now make sure the array is sorted for proper continuation
  70                 sort( $tags );
  71
  72                 $count = 0;
  73                 foreach ( $tags as $tagName ) {
  74                         if ( ++$count > $limit ) {
  75                                 $this->setContinueEnumParameter( 'continue', $tagName );
  76                                 break;
  77                         }
  78
  79                         $tag = [];
  80                         $tag['name'] = $tagName;
  81
  82                         if ( $fld_displayname ) {
  83                                 $tag['displayname'] = ChangeTags::tagDescription( $tagName, $this );
  84                         }
  85
  86                         if ( $fld_description ) {
  87                                 $msg = $this->msg( "tag-$tagName-description" );
  88                                 $tag['description'] = $msg->exists() ? $msg->text() : '';
  89                         }
  90
  91                         if ( $fld_hitcount ) {
  92                                 $tag['hitcount'] = intval( $tagHitcounts[$tagName] );
  93                         }
  94
  95                         $isSoftware = isset( $softwareDefinedTags[$tagName] );
  96                         $isExplicit = isset( $explicitlyDefinedTags[$tagName] );
  97
  98                         if ( $fld_defined ) {
  99                                 $tag['defined'] = $isSoftware || $isExplicit;
 100                         }
 101
 102                         if ( $fld_source ) {
 103                                 $tag['source'] = [];
 104                                 if ( $isSoftware ) {
 105                                         // TODO: Can we change this to 'software'?
 106                                         $tag['source'][] = 'extension';
 107                                 }
 108                                 if ( $isExplicit ) {
 109                                         $tag['source'][] = 'manual';
 110                                 }
 111                         }
 112
 113                         if ( $fld_active ) {
 114                                 $tag['active'] = $isExplicit || isset( $softwareActivatedTags[$tagName] );
 115                         }
 116
 117                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $tag );
 118                         if ( !$fit ) {
 119                                 $this->setContinueEnumParameter( 'continue', $tagName );
 120                                 break;
 121                         }
 122                 }
 123
 124                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'tag' );
 125         }
 126
 127         public function getCacheMode( $params ) {
 128                 return 'public';
 129         }
 130
 131         public function getAllowedParams() {
 132                 return [
 133                         'continue' => [
 134                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 135                         ],
 136                         'limit' => [
 137                                 ApiBase::PARAM_DFLT => 10,
 138                                 ApiBase::PARAM_TYPE => 'limit',
 139                                 ApiBase::PARAM_MIN => 1,
 140                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 141                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 142                         ],
 143                         'prop' => [
 144                                 ApiBase::PARAM_DFLT => 'name',
 145                                 ApiBase::PARAM_TYPE => [
 146                                         'name',
 147                                         'displayname',
 148                                         'description',
 149                                         'hitcount',
 150                                         'defined',
 151                                         'source',
 152                                         'active',
 153                                 ],
 154                                 ApiBase::PARAM_ISMULTI => true,
 155                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 156                         ]
 157                 ];
 158         }
 159
 160         protected function getExamplesMessages() {
 161                 return [
 162                         'action=query&list=tags&tgprop=displayname|description|hitcount|defined'
 163                                 => 'apihelp-query+tags-example-simple',
 164                 ];
 165         }
 166
 167         public function getHelpUrls() {
 168                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Tags';
 169         }
 170 }