includes/api/ApiQuerySiteinfo.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 25, 2006
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   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  * A query action to return meta information about the wiki site.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQuerySiteinfo extends ApiQueryBase {
  33
  34         public function __construct( ApiQuery $query, $moduleName ) {
  35                 parent::__construct( $query, $moduleName, 'si' );
  36         }
  37
  38         public function execute() {
  39                 $params = $this->extractRequestParams();
  40                 $done = array();
  41                 $fit = false;
  42                 foreach ( $params['prop'] as $p ) {
  43                         switch ( $p ) {
  44                                 case 'general':
  45                                         $fit = $this->appendGeneralInfo( $p );
  46                                         break;
  47                                 case 'namespaces':
  48                                         $fit = $this->appendNamespaces( $p );
  49                                         break;
  50                                 case 'namespacealiases':
  51                                         $fit = $this->appendNamespaceAliases( $p );
  52                                         break;
  53                                 case 'specialpagealiases':
  54                                         $fit = $this->appendSpecialPageAliases( $p );
  55                                         break;
  56                                 case 'magicwords':
  57                                         $fit = $this->appendMagicWords( $p );
  58                                         break;
  59                                 case 'interwikimap':
  60                                         $filteriw = isset( $params['filteriw'] ) ? $params['filteriw'] : false;
  61                                         $fit = $this->appendInterwikiMap( $p, $filteriw );
  62                                         break;
  63                                 case 'dbrepllag':
  64                                         $fit = $this->appendDbReplLagInfo( $p, $params['showalldb'] );
  65                                         break;
  66                                 case 'statistics':
  67                                         $fit = $this->appendStatistics( $p );
  68                                         break;
  69                                 case 'usergroups':
  70                                         $fit = $this->appendUserGroups( $p, $params['numberingroup'] );
  71                                         break;
  72                                 case 'libraries':
  73                                         $fit = $this->appendInstalledLibraries( $p );
  74                                         break;
  75                                 case 'extensions':
  76                                         $fit = $this->appendExtensions( $p );
  77                                         break;
  78                                 case 'fileextensions':
  79                                         $fit = $this->appendFileExtensions( $p );
  80                                         break;
  81                                 case 'rightsinfo':
  82                                         $fit = $this->appendRightsInfo( $p );
  83                                         break;
  84                                 case 'restrictions':
  85                                         $fit = $this->appendRestrictions( $p );
  86                                         break;
  87                                 case 'languages':
  88                                         $fit = $this->appendLanguages( $p );
  89                                         break;
  90                                 case 'skins':
  91                                         $fit = $this->appendSkins( $p );
  92                                         break;
  93                                 case 'extensiontags':
  94                                         $fit = $this->appendExtensionTags( $p );
  95                                         break;
  96                                 case 'functionhooks':
  97                                         $fit = $this->appendFunctionHooks( $p );
  98                                         break;
  99                                 case 'showhooks':
 100                                         $fit = $this->appendSubscribedHooks( $p );
 101                                         break;
 102                                 case 'variables':
 103                                         $fit = $this->appendVariables( $p );
 104                                         break;
 105                                 case 'protocols':
 106                                         $fit = $this->appendProtocols( $p );
 107                                         break;
 108                                 case 'defaultoptions':
 109                                         $fit = $this->appendDefaultOptions( $p );
 110                                         break;
 111                                 default:
 112                                         ApiBase::dieDebug( __METHOD__, "Unknown prop=$p" );
 113                         }
 114                         if ( !$fit ) {
 115                                 // Abuse siprop as a query-continue parameter
 116                                 // and set it to all unprocessed props
 117                                 $this->setContinueEnumParameter( 'prop', implode( '|',
 118                                         array_diff( $params['prop'], $done ) ) );
 119                                 break;
 120                         }
 121                         $done[] = $p;
 122                 }
 123         }
 124
 125         protected function appendGeneralInfo( $property ) {
 126                 global $wgContLang;
 127
 128                 $config = $this->getConfig();
 129
 130                 $data = array();
 131                 $mainPage = Title::newMainPage();
 132                 $data['mainpage'] = $mainPage->getPrefixedText();
 133                 $data['base'] = wfExpandUrl( $mainPage->getFullURL(), PROTO_CURRENT );
 134                 $data['sitename'] = $config->get( 'Sitename' );
 135
 136                 // wgLogo can either be a relative or an absolute path
 137                 // make sure we always return an absolute path
 138                 $data['logo'] = wfExpandUrl( $config->get( 'Logo' ), PROTO_RELATIVE );
 139
 140                 $data['generator'] = "MediaWiki {$config->get( 'Version' )}";
 141
 142                 $data['phpversion'] = PHP_VERSION;
 143                 $data['phpsapi'] = PHP_SAPI;
 144                 if ( defined( 'HHVM_VERSION' ) ) {
 145                         $data['hhvmversion'] = HHVM_VERSION;
 146                 }
 147                 $data['dbtype'] = $config->get( 'DBtype' );
 148                 $data['dbversion'] = $this->getDB()->getServerVersion();
 149
 150                 $allowFrom = array( '' );
 151                 $allowException = true;
 152                 if ( !$config->get( 'AllowExternalImages' ) ) {
 153                         $data['imagewhitelistenabled'] = (bool)$config->get( 'EnableImageWhitelist' );
 154                         $allowFrom = $config->get( 'AllowExternalImagesFrom' );
 155                         $allowException = !empty( $allowFrom );
 156                 }
 157                 if ( $allowException ) {
 158                         $data['externalimages'] = (array)$allowFrom;
 159                         ApiResult::setIndexedTagName( $data['externalimages'], 'prefix' );
 160                 }
 161
 162                 $data['langconversion'] = !$config->get( 'DisableLangConversion' );
 163                 $data['titleconversion'] = !$config->get( 'DisableTitleConversion' );
 164
 165                 if ( $wgContLang->linkPrefixExtension() ) {
 166                         $linkPrefixCharset = $wgContLang->linkPrefixCharset();
 167                         $data['linkprefixcharset'] = $linkPrefixCharset;
 168                         // For backwards compatibility
 169                         $data['linkprefix'] = "/^((?>.*[^$linkPrefixCharset]|))(.+)$/sDu";
 170                 } else {
 171                         $data['linkprefixcharset'] = '';
 172                         $data['linkprefix'] = '';
 173                 }
 174
 175                 $linktrail = $wgContLang->linkTrail();
 176                 $data['linktrail'] = $linktrail ?: '';
 177
 178                 $data['legaltitlechars'] = Title::legalChars();
 179                 $data['invalidusernamechars'] = $config->get( 'InvalidUsernameCharacters' );
 180
 181                 global $IP;
 182                 $git = SpecialVersion::getGitHeadSha1( $IP );
 183                 if ( $git ) {
 184                         $data['git-hash'] = $git;
 185                         $data['git-branch'] =
 186                                 SpecialVersion::getGitCurrentBranch( $GLOBALS['IP'] );
 187                 } else {
 188                         $svn = SpecialVersion::getSvnRevision( $IP );
 189                         if ( $svn ) {
 190                                 $data['rev'] = $svn;
 191                         }
 192                 }
 193
 194                 // 'case-insensitive' option is reserved for future
 195                 $data['case'] = $config->get( 'CapitalLinks' ) ? 'first-letter' : 'case-sensitive';
 196                 $data['lang'] = $config->get( 'LanguageCode' );
 197
 198                 $fallbacks = array();
 199                 foreach ( $wgContLang->getFallbackLanguages() as $code ) {
 200                         $fallbacks[] = array( 'code' => $code );
 201                 }
 202                 $data['fallback'] = $fallbacks;
 203                 ApiResult::setIndexedTagName( $data['fallback'], 'lang' );
 204
 205                 if ( $wgContLang->hasVariants() ) {
 206                         $variants = array();
 207                         foreach ( $wgContLang->getVariants() as $code ) {
 208                                 $variants[] = array(
 209                                         'code' => $code,
 210                                         'name' => $wgContLang->getVariantname( $code ),
 211                                 );
 212                         }
 213                         $data['variants'] = $variants;
 214                         ApiResult::setIndexedTagName( $data['variants'], 'lang' );
 215                 }
 216
 217                 $data['rtl'] = $wgContLang->isRTL();
 218                 $data['fallback8bitEncoding'] = $wgContLang->fallback8bitEncoding();
 219
 220                 $data['readonly'] = wfReadOnly();
 221                 if ( $data['readonly'] ) {
 222                         $data['readonlyreason'] = wfReadOnlyReason();
 223                 }
 224                 $data['writeapi'] = (bool)$config->get( 'EnableWriteAPI' );
 225
 226                 $tz = $config->get( 'Localtimezone' );
 227                 $offset = $config->get( 'LocalTZoffset' );
 228                 if ( is_null( $tz ) ) {
 229                         $tz = 'UTC';
 230                         $offset = 0;
 231                 } elseif ( is_null( $offset ) ) {
 232                         $offset = 0;
 233                 }
 234                 $data['timezone'] = $tz;
 235                 $data['timeoffset'] = intval( $offset );
 236                 $data['articlepath'] = $config->get( 'ArticlePath' );
 237                 $data['scriptpath'] = $config->get( 'ScriptPath' );
 238                 $data['script'] = $config->get( 'Script' );
 239                 $data['variantarticlepath'] = $config->get( 'VariantArticlePath' );
 240                 $data[ApiResult::META_BC_BOOLS][] = 'variantarticlepath';
 241                 $data['server'] = $config->get( 'Server' );
 242                 $data['servername'] = $config->get( 'ServerName' );
 243                 $data['wikiid'] = wfWikiID();
 244                 $data['time'] = wfTimestamp( TS_ISO_8601, time() );
 245
 246                 $data['misermode'] = (bool)$config->get( 'MiserMode' );
 247
 248                 $data['maxuploadsize'] = UploadBase::getMaxUploadSize();
 249                 $data['minuploadchunksize'] = (int)$this->getConfig()->get( 'MinUploadChunkSize' );
 250
 251                 $data['thumblimits'] = $config->get( 'ThumbLimits' );
 252                 ApiResult::setArrayType( $data['thumblimits'], 'BCassoc' );
 253                 ApiResult::setIndexedTagName( $data['thumblimits'], 'limit' );
 254                 $data['imagelimits'] = array();
 255                 ApiResult::setArrayType( $data['imagelimits'], 'BCassoc' );
 256                 ApiResult::setIndexedTagName( $data['imagelimits'], 'limit' );
 257                 foreach ( $config->get( 'ImageLimits' ) as $k => $limit ) {
 258                         $data['imagelimits'][$k] = array( 'width' => $limit[0], 'height' => $limit[1] );
 259                 }
 260
 261                 $favicon = $config->get( 'Favicon' );
 262                 if ( !empty( $favicon ) ) {
 263                         // wgFavicon can either be a relative or an absolute path
 264                         // make sure we always return an absolute path
 265                         $data['favicon'] = wfExpandUrl( $favicon, PROTO_RELATIVE );
 266                 }
 267
 268                 Hooks::run( 'APIQuerySiteInfoGeneralInfo', array( $this, &$data ) );
 269
 270                 return $this->getResult()->addValue( 'query', $property, $data );
 271         }
 272
 273         protected function appendNamespaces( $property ) {
 274                 global $wgContLang;
 275                 $data = array(
 276                         ApiResult::META_TYPE => 'assoc',
 277                 );
 278                 foreach ( $wgContLang->getFormattedNamespaces() as $ns => $title ) {
 279                         $data[$ns] = array(
 280                                 'id' => intval( $ns ),
 281                                 'case' => MWNamespace::isCapitalized( $ns ) ? 'first-letter' : 'case-sensitive',
 282                         );
 283                         ApiResult::setContentValue( $data[$ns], 'name', $title );
 284                         $canonical = MWNamespace::getCanonicalName( $ns );
 285
 286                         $data[$ns]['subpages'] = MWNamespace::hasSubpages( $ns );
 287
 288                         if ( $canonical ) {
 289                                 $data[$ns]['canonical'] = strtr( $canonical, '_', ' ' );
 290                         }
 291
 292                         $data[$ns]['content'] = MWNamespace::isContent( $ns );
 293                         $data[$ns]['nonincludable'] = MWNamespace::isNonincludable( $ns );
 294
 295                         $contentmodel = MWNamespace::getNamespaceContentModel( $ns );
 296                         if ( $contentmodel ) {
 297                                 $data[$ns]['defaultcontentmodel'] = $contentmodel;
 298                         }
 299                 }
 300
 301                 ApiResult::setArrayType( $data, 'assoc' );
 302                 ApiResult::setIndexedTagName( $data, 'ns' );
 303
 304                 return $this->getResult()->addValue( 'query', $property, $data );
 305         }
 306
 307         protected function appendNamespaceAliases( $property ) {
 308                 global $wgContLang;
 309                 $aliases = array_merge( $this->getConfig()->get( 'NamespaceAliases' ),
 310                         $wgContLang->getNamespaceAliases() );
 311                 $namespaces = $wgContLang->getNamespaces();
 312                 $data = array();
 313                 foreach ( $aliases as $title => $ns ) {
 314                         if ( $namespaces[$ns] == $title ) {
 315                                 // Don't list duplicates
 316                                 continue;
 317                         }
 318                         $item = array(
 319                                 'id' => intval( $ns )
 320                         );
 321                         ApiResult::setContentValue( $item, 'alias', strtr( $title, '_', ' ' ) );
 322                         $data[] = $item;
 323                 }
 324
 325                 sort( $data );
 326
 327                 ApiResult::setIndexedTagName( $data, 'ns' );
 328
 329                 return $this->getResult()->addValue( 'query', $property, $data );
 330         }
 331
 332         protected function appendSpecialPageAliases( $property ) {
 333                 global $wgContLang;
 334                 $data = array();
 335                 $aliases = $wgContLang->getSpecialPageAliases();
 336                 foreach ( SpecialPageFactory::getNames() as $specialpage ) {
 337                         if ( isset( $aliases[$specialpage] ) ) {
 338                                 $arr = array( 'realname' => $specialpage, 'aliases' => $aliases[$specialpage] );
 339                                 ApiResult::setIndexedTagName( $arr['aliases'], 'alias' );
 340                                 $data[] = $arr;
 341                         }
 342                 }
 343                 ApiResult::setIndexedTagName( $data, 'specialpage' );
 344
 345                 return $this->getResult()->addValue( 'query', $property, $data );
 346         }
 347
 348         protected function appendMagicWords( $property ) {
 349                 global $wgContLang;
 350                 $data = array();
 351                 foreach ( $wgContLang->getMagicWords() as $magicword => $aliases ) {
 352                         $caseSensitive = array_shift( $aliases );
 353                         $arr = array( 'name' => $magicword, 'aliases' => $aliases );
 354                         $arr['case-sensitive'] = (bool)$caseSensitive;
 355                         ApiResult::setIndexedTagName( $arr['aliases'], 'alias' );
 356                         $data[] = $arr;
 357                 }
 358                 ApiResult::setIndexedTagName( $data, 'magicword' );
 359
 360                 return $this->getResult()->addValue( 'query', $property, $data );
 361         }
 362
 363         protected function appendInterwikiMap( $property, $filter ) {
 364                 $local = null;
 365                 if ( $filter === 'local' ) {
 366                         $local = 1;
 367                 } elseif ( $filter === '!local' ) {
 368                         $local = 0;
 369                 } elseif ( $filter ) {
 370                         ApiBase::dieDebug( __METHOD__, "Unknown filter=$filter" );
 371                 }
 372
 373                 $params = $this->extractRequestParams();
 374                 $langCode = isset( $params['inlanguagecode'] ) ? $params['inlanguagecode'] : '';
 375                 $langNames = Language::fetchLanguageNames( $langCode );
 376
 377                 $getPrefixes = Interwiki::getAllPrefixes( $local );
 378                 $extraLangPrefixes = $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' );
 379                 $localInterwikis = $this->getConfig()->get( 'LocalInterwikis' );
 380                 $data = array();
 381
 382                 foreach ( $getPrefixes as $row ) {
 383                         $prefix = $row['iw_prefix'];
 384                         $val = array();
 385                         $val['prefix'] = $prefix;
 386                         if ( isset( $row['iw_local'] ) && $row['iw_local'] == '1' ) {
 387                                 $val['local'] = true;
 388                         }
 389                         if ( isset( $row['iw_trans'] ) && $row['iw_trans'] == '1' ) {
 390                                 $val['trans'] = true;
 391                         }
 392
 393                         if ( isset( $langNames[$prefix] ) ) {
 394                                 $val['language'] = $langNames[$prefix];
 395                         }
 396                         if ( in_array( $prefix, $localInterwikis ) ) {
 397                                 $val['localinterwiki'] = true;
 398                         }
 399                         if ( in_array( $prefix, $extraLangPrefixes ) ) {
 400                                 $val['extralanglink'] = true;
 401
 402                                 $linktext = wfMessage( "interlanguage-link-$prefix" );
 403                                 if ( !$linktext->isDisabled() ) {
 404                                         $val['linktext'] = $linktext->text();
 405                                 }
 406
 407                                 $sitename = wfMessage( "interlanguage-link-sitename-$prefix" );
 408                                 if ( !$sitename->isDisabled() ) {
 409                                         $val['sitename'] = $sitename->text();
 410                                 }
 411                         }
 412
 413                         $val['url'] = wfExpandUrl( $row['iw_url'], PROTO_CURRENT );
 414                         $val['protorel'] = substr( $row['iw_url'], 0, 2 ) == '//';
 415                         if ( isset( $row['iw_wikiid'] ) && $row['iw_wikiid'] !== '' ) {
 416                                 $val['wikiid'] = $row['iw_wikiid'];
 417                         }
 418                         if ( isset( $row['iw_api'] ) && $row['iw_api'] !== '' ) {
 419                                 $val['api'] = $row['iw_api'];
 420                         }
 421
 422                         $data[] = $val;
 423                 }
 424
 425                 ApiResult::setIndexedTagName( $data, 'iw' );
 426
 427                 return $this->getResult()->addValue( 'query', $property, $data );
 428         }
 429
 430         protected function appendDbReplLagInfo( $property, $includeAll ) {
 431                 $data = array();
 432                 $lb = wfGetLB();
 433                 $showHostnames = $this->getConfig()->get( 'ShowHostnames' );
 434                 if ( $includeAll ) {
 435                         if ( !$showHostnames ) {
 436                                 $this->dieUsage(
 437                                         'Cannot view all servers info unless $wgShowHostnames is true',
 438                                         'includeAllDenied'
 439                                 );
 440                         }
 441
 442                         $lags = $lb->getLagTimes();
 443                         foreach ( $lags as $i => $lag ) {
 444                                 $data[] = array(
 445                                         'host' => $lb->getServerName( $i ),
 446                                         'lag' => $lag
 447                                 );
 448                         }
 449                 } else {
 450                         list( , $lag, $index ) = $lb->getMaxLag();
 451                         $data[] = array(
 452                                 'host' => $showHostnames
 453                                                 ? $lb->getServerName( $index )
 454                                                 : '',
 455                                 'lag' => intval( $lag )
 456                         );
 457                 }
 458
 459                 ApiResult::setIndexedTagName( $data, 'db' );
 460
 461                 return $this->getResult()->addValue( 'query', $property, $data );
 462         }
 463
 464         protected function appendStatistics( $property ) {
 465                 $data = array();
 466                 $data['pages'] = intval( SiteStats::pages() );
 467                 $data['articles'] = intval( SiteStats::articles() );
 468                 $data['edits'] = intval( SiteStats::edits() );
 469                 $data['images'] = intval( SiteStats::images() );
 470                 $data['users'] = intval( SiteStats::users() );
 471                 $data['activeusers'] = intval( SiteStats::activeUsers() );
 472                 $data['admins'] = intval( SiteStats::numberingroup( 'sysop' ) );
 473                 $data['jobs'] = intval( SiteStats::jobs() );
 474
 475                 Hooks::run( 'APIQuerySiteInfoStatisticsInfo', array( &$data ) );
 476
 477                 return $this->getResult()->addValue( 'query', $property, $data );
 478         }
 479
 480         protected function appendUserGroups( $property, $numberInGroup ) {
 481                 $config = $this->getConfig();
 482
 483                 $data = array();
 484                 $result = $this->getResult();
 485                 $allGroups = User::getAllGroups();
 486                 foreach ( $config->get( 'GroupPermissions' ) as $group => $permissions ) {
 487                         $arr = array(
 488                                 'name' => $group,
 489                                 'rights' => array_keys( $permissions, true ),
 490                         );
 491
 492                         if ( $numberInGroup ) {
 493                                 $autopromote = $config->get( 'Autopromote' );
 494
 495                                 if ( $group == 'user' ) {
 496                                         $arr['number'] = SiteStats::users();
 497                                 // '*' and autopromote groups have no size
 498                                 } elseif ( $group !== '*' && !isset( $autopromote[$group] ) ) {
 499                                         $arr['number'] = SiteStats::numberingroup( $group );
 500                                 }
 501                         }
 502
 503                         $groupArr = array(
 504                                 'add' => $config->get( 'AddGroups' ),
 505                                 'remove' => $config->get( 'RemoveGroups' ),
 506                                 'add-self' => $config->get( 'GroupsAddToSelf' ),
 507                                 'remove-self' => $config->get( 'GroupsRemoveFromSelf' )
 508                         );
 509
 510                         foreach ( $groupArr as $type => $rights ) {
 511                                 if ( isset( $rights[$group] ) ) {
 512                                         $groups = array_intersect( $rights[$group], $allGroups );
 513                                         if ( $groups ) {
 514                                                 $arr[$type] = $groups;
 515                                                 ApiResult::setArrayType( $arr[$type], 'BCarray' );
 516                                                 ApiResult::setIndexedTagName( $arr[$type], 'group' );
 517                                         }
 518                                 }
 519                         }
 520
 521                         ApiResult::setIndexedTagName( $arr['rights'], 'permission' );
 522                         $data[] = $arr;
 523                 }
 524
 525                 ApiResult::setIndexedTagName( $data, 'group' );
 526
 527                 return $result->addValue( 'query', $property, $data );
 528         }
 529
 530         protected function appendFileExtensions( $property ) {
 531                 $data = array();
 532                 foreach ( array_unique( $this->getConfig()->get( 'FileExtensions' ) ) as $ext ) {
 533                         $data[] = array( 'ext' => $ext );
 534                 }
 535                 ApiResult::setIndexedTagName( $data, 'fe' );
 536
 537                 return $this->getResult()->addValue( 'query', $property, $data );
 538         }
 539
 540         protected function appendInstalledLibraries( $property ) {
 541                 global $IP;
 542                 $path = "$IP/vendor/composer/installed.json";
 543                 if ( !file_exists( $path ) ) {
 544                         return true;
 545                 }
 546
 547                 $data = array();
 548                 $installed = new ComposerInstalled( $path );
 549                 foreach ( $installed->getInstalledDependencies() as $name => $info ) {
 550                         if ( strpos( $info['type'], 'mediawiki-' ) === 0 ) {
 551                                 // Skip any extensions or skins since they'll be listed
 552                                 // in their proper section
 553                                 continue;
 554                         }
 555                         $data[] = array(
 556                                 'name' => $name,
 557                                 'version' => $info['version'],
 558                         );
 559                 }
 560                 ApiResult::setIndexedTagName( $data, 'library' );
 561
 562                 return $this->getResult()->addValue( 'query', $property, $data );
 563
 564         }
 565
 566         protected function appendExtensions( $property ) {
 567                 $data = array();
 568                 foreach ( $this->getConfig()->get( 'ExtensionCredits' ) as $type => $extensions ) {
 569                         foreach ( $extensions as $ext ) {
 570                                 $ret = array();
 571                                 $ret['type'] = $type;
 572                                 if ( isset( $ext['name'] ) ) {
 573                                         $ret['name'] = $ext['name'];
 574                                 }
 575                                 if ( isset( $ext['namemsg'] ) ) {
 576                                         $ret['namemsg'] = $ext['namemsg'];
 577                                 }
 578                                 if ( isset( $ext['description'] ) ) {
 579                                         $ret['description'] = $ext['description'];
 580                                 }
 581                                 if ( isset( $ext['descriptionmsg'] ) ) {
 582                                         // Can be a string or array( key, param1, param2, ... )
 583                                         if ( is_array( $ext['descriptionmsg'] ) ) {
 584                                                 $ret['descriptionmsg'] = $ext['descriptionmsg'][0];
 585                                                 $ret['descriptionmsgparams'] = array_slice( $ext['descriptionmsg'], 1 );
 586                                                 ApiResult::setIndexedTagName( $ret['descriptionmsgparams'], 'param' );
 587                                         } else {
 588                                                 $ret['descriptionmsg'] = $ext['descriptionmsg'];
 589                                         }
 590                                 }
 591                                 if ( isset( $ext['author'] ) ) {
 592                                         $ret['author'] = is_array( $ext['author'] ) ?
 593                                                 implode( ', ', $ext['author'] ) : $ext['author'];
 594                                 }
 595                                 if ( isset( $ext['url'] ) ) {
 596                                         $ret['url'] = $ext['url'];
 597                                 }
 598                                 if ( isset( $ext['version'] ) ) {
 599                                         $ret['version'] = $ext['version'];
 600                                 } elseif ( isset( $ext['svn-revision'] ) &&
 601                                         preg_match( '/\$(?:Rev|LastChangedRevision|Revision): *(\d+)/',
 602                                                 $ext['svn-revision'], $m )
 603                                 ) {
 604                                         $ret['version'] = 'r' . $m[1];
 605                                 }
 606                                 if ( isset( $ext['path'] ) ) {
 607                                         $extensionPath = dirname( $ext['path'] );
 608                                         $gitInfo = new GitInfo( $extensionPath );
 609                                         $vcsVersion = $gitInfo->getHeadSHA1();
 610                                         if ( $vcsVersion !== false ) {
 611                                                 $ret['vcs-system'] = 'git';
 612                                                 $ret['vcs-version'] = $vcsVersion;
 613                                                 $ret['vcs-url'] = $gitInfo->getHeadViewUrl();
 614                                                 $vcsDate = $gitInfo->getHeadCommitDate();
 615                                                 if ( $vcsDate !== false ) {
 616                                                         $ret['vcs-date'] = wfTimestamp( TS_ISO_8601, $vcsDate );
 617                                                 }
 618                                         } else {
 619                                                 $svnInfo = SpecialVersion::getSvnInfo( $extensionPath );
 620                                                 if ( $svnInfo !== false ) {
 621                                                         $ret['vcs-system'] = 'svn';
 622                                                         $ret['vcs-version'] = $svnInfo['checkout-rev'];
 623                                                         $ret['vcs-url'] = isset( $svnInfo['viewvc-url'] ) ? $svnInfo['viewvc-url'] : '';
 624                                                 }
 625                                         }
 626
 627                                         if ( SpecialVersion::getExtLicenseFileName( $extensionPath ) ) {
 628                                                 $ret['license-name'] = isset( $ext['license-name'] ) ? $ext['license-name'] : '';
 629                                                 $ret['license'] = SpecialPage::getTitleFor(
 630                                                         'Version',
 631                                                         "License/{$ext['name']}"
 632                                                 )->getLinkURL();
 633                                         }
 634
 635                                         if ( SpecialVersion::getExtAuthorsFileName( $extensionPath ) ) {
 636                                                 $ret['credits'] = SpecialPage::getTitleFor(
 637                                                         'Version',
 638                                                         "Credits/{$ext['name']}"
 639                                                 )->getLinkURL();
 640                                         }
 641                                 }
 642                                 $data[] = $ret;
 643                         }
 644                 }
 645
 646                 ApiResult::setIndexedTagName( $data, 'ext' );
 647
 648                 return $this->getResult()->addValue( 'query', $property, $data );
 649         }
 650
 651         protected function appendRightsInfo( $property ) {
 652                 $config = $this->getConfig();
 653                 $rightsPage = $config->get( 'RightsPage' );
 654                 if ( is_string( $rightsPage ) ) {
 655                         $title = Title::newFromText( $rightsPage );
 656                         $url = wfExpandUrl( $title, PROTO_CURRENT );
 657                 } else {
 658                         $title = false;
 659                         $url = $config->get( 'RightsUrl' );
 660                 }
 661                 $text = $config->get( 'RightsText' );
 662                 if ( !$text && $title ) {
 663                         $text = $title->getPrefixedText();
 664                 }
 665
 666                 $data = array(
 667                         'url' => $url ? $url : '',
 668                         'text' => $text ? $text : ''
 669                 );
 670
 671                 return $this->getResult()->addValue( 'query', $property, $data );
 672         }
 673
 674         protected function appendRestrictions( $property ) {
 675                 $config = $this->getConfig();
 676                 $data = array(
 677                         'types' => $config->get( 'RestrictionTypes' ),
 678                         'levels' => $config->get( 'RestrictionLevels' ),
 679                         'cascadinglevels' => $config->get( 'CascadingRestrictionLevels' ),
 680                         'semiprotectedlevels' => $config->get( 'SemiprotectedRestrictionLevels' ),
 681                 );
 682
 683                 ApiResult::setArrayType( $data['types'], 'BCarray' );
 684                 ApiResult::setArrayType( $data['levels'], 'BCarray' );
 685                 ApiResult::setArrayType( $data['cascadinglevels'], 'BCarray' );
 686                 ApiResult::setArrayType( $data['semiprotectedlevels'], 'BCarray' );
 687
 688                 ApiResult::setIndexedTagName( $data['types'], 'type' );
 689                 ApiResult::setIndexedTagName( $data['levels'], 'level' );
 690                 ApiResult::setIndexedTagName( $data['cascadinglevels'], 'level' );
 691                 ApiResult::setIndexedTagName( $data['semiprotectedlevels'], 'level' );
 692
 693                 return $this->getResult()->addValue( 'query', $property, $data );
 694         }
 695
 696         public function appendLanguages( $property ) {
 697                 $params = $this->extractRequestParams();
 698                 $langCode = isset( $params['inlanguagecode'] ) ? $params['inlanguagecode'] : '';
 699                 $langNames = Language::fetchLanguageNames( $langCode );
 700
 701                 $data = array();
 702
 703                 foreach ( $langNames as $code => $name ) {
 704                         $lang = array( 'code' => $code );
 705                         ApiResult::setContentValue( $lang, 'name', $name );
 706                         $data[] = $lang;
 707                 }
 708                 ApiResult::setIndexedTagName( $data, 'lang' );
 709
 710                 return $this->getResult()->addValue( 'query', $property, $data );
 711         }
 712
 713         public function appendSkins( $property ) {
 714                 $data = array();
 715                 $allowed = Skin::getAllowedSkins();
 716                 $default = Skin::normalizeKey( 'default' );
 717                 foreach ( Skin::getSkinNames() as $name => $displayName ) {
 718                         $msg = $this->msg( "skinname-{$name}" );
 719                         $code = $this->getParameter( 'inlanguagecode' );
 720                         if ( $code && Language::isValidCode( $code ) ) {
 721                                 $msg->inLanguage( $code );
 722                         } else {
 723                                 $msg->inContentLanguage();
 724                         }
 725                         if ( $msg->exists() ) {
 726                                 $displayName = $msg->text();
 727                         }
 728                         $skin = array( 'code' => $name );
 729                         ApiResult::setContentValue( $skin, 'name', $displayName );
 730                         if ( !isset( $allowed[$name] ) ) {
 731                                 $skin['unusable'] = true;
 732                         }
 733                         if ( $name === $default ) {
 734                                 $skin['default'] = true;
 735                         }
 736                         $data[] = $skin;
 737                 }
 738                 ApiResult::setIndexedTagName( $data, 'skin' );
 739
 740                 return $this->getResult()->addValue( 'query', $property, $data );
 741         }
 742
 743         public function appendExtensionTags( $property ) {
 744                 global $wgParser;
 745                 $wgParser->firstCallInit();
 746                 $tags = array_map( array( $this, 'formatParserTags' ), $wgParser->getTags() );
 747                 ApiResult::setArrayType( $tags, 'BCarray' );
 748                 ApiResult::setIndexedTagName( $tags, 't' );
 749
 750                 return $this->getResult()->addValue( 'query', $property, $tags );
 751         }
 752
 753         public function appendFunctionHooks( $property ) {
 754                 global $wgParser;
 755                 $wgParser->firstCallInit();
 756                 $hooks = $wgParser->getFunctionHooks();
 757                 ApiResult::setArrayType( $hooks, 'BCarray' );
 758                 ApiResult::setIndexedTagName( $hooks, 'h' );
 759
 760                 return $this->getResult()->addValue( 'query', $property, $hooks );
 761         }
 762
 763         public function appendVariables( $property ) {
 764                 $variables = MagicWord::getVariableIDs();
 765                 ApiResult::setArrayType( $variables, 'BCarray' );
 766                 ApiResult::setIndexedTagName( $variables, 'v' );
 767
 768                 return $this->getResult()->addValue( 'query', $property, $variables );
 769         }
 770
 771         public function appendProtocols( $property ) {
 772                 // Make a copy of the global so we don't try to set the _element key of it - bug 45130
 773                 $protocols = array_values( $this->getConfig()->get( 'UrlProtocols' ) );
 774                 ApiResult::setArrayType( $protocols, 'BCarray' );
 775                 ApiResult::setIndexedTagName( $protocols, 'p' );
 776
 777                 return $this->getResult()->addValue( 'query', $property, $protocols );
 778         }
 779
 780         public function appendDefaultOptions( $property ) {
 781                 $options = User::getDefaultOptions();
 782                 $options[ApiResult::META_BC_BOOLS] = array_keys( $options );
 783                 return $this->getResult()->addValue( 'query', $property, $options );
 784         }
 785
 786         private function formatParserTags( $item ) {
 787                 return "<{$item}>";
 788         }
 789
 790         public function appendSubscribedHooks( $property ) {
 791                 $hooks = $this->getConfig()->get( 'Hooks' );
 792                 $myWgHooks = $hooks;
 793                 ksort( $myWgHooks );
 794
 795                 $data = array();
 796                 foreach ( $myWgHooks as $name => $subscribers ) {
 797                         $arr = array(
 798                                 'name' => $name,
 799                                 'subscribers' => array_map( array( 'SpecialVersion', 'arrayToString' ), $subscribers ),
 800                         );
 801
 802                         ApiResult::setArrayType( $arr['subscribers'], 'array' );
 803                         ApiResult::setIndexedTagName( $arr['subscribers'], 's' );
 804                         $data[] = $arr;
 805                 }
 806
 807                 ApiResult::setIndexedTagName( $data, 'hook' );
 808
 809                 return $this->getResult()->addValue( 'query', $property, $data );
 810         }
 811
 812         public function getCacheMode( $params ) {
 813                 // Messages for $wgExtraInterlanguageLinkPrefixes depend on user language
 814                 if (
 815                         count( $this->getConfig()->get( 'ExtraInterlanguageLinkPrefixes' ) ) &&
 816                         !is_null( $params['prop'] ) &&
 817                         in_array( 'interwikimap', $params['prop'] )
 818                 ) {
 819                         return 'anon-public-user-private';
 820                 }
 821
 822                 return 'public';
 823         }
 824
 825         public function getAllowedParams() {
 826                 return array(
 827                         'prop' => array(
 828                                 ApiBase::PARAM_DFLT => 'general',
 829                                 ApiBase::PARAM_ISMULTI => true,
 830                                 ApiBase::PARAM_TYPE => array(
 831                                         'general',
 832                                         'namespaces',
 833                                         'namespacealiases',
 834                                         'specialpagealiases',
 835                                         'magicwords',
 836                                         'interwikimap',
 837                                         'dbrepllag',
 838                                         'statistics',
 839                                         'usergroups',
 840                                         'libraries',
 841                                         'extensions',
 842                                         'fileextensions',
 843                                         'rightsinfo',
 844                                         'restrictions',
 845                                         'languages',
 846                                         'skins',
 847                                         'extensiontags',
 848                                         'functionhooks',
 849                                         'showhooks',
 850                                         'variables',
 851                                         'protocols',
 852                                         'defaultoptions',
 853                                 ),
 854                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => array(),
 855                         ),
 856                         'filteriw' => array(
 857                                 ApiBase::PARAM_TYPE => array(
 858                                         'local',
 859                                         '!local',
 860                                 )
 861                         ),
 862                         'showalldb' => false,
 863                         'numberingroup' => false,
 864                         'inlanguagecode' => null,
 865                 );
 866         }
 867
 868         protected function getExamplesMessages() {
 869                 return array(
 870                         'action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics'
 871                                 => 'apihelp-query+siteinfo-example-simple',
 872                         'action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local'
 873                                 => 'apihelp-query+siteinfo-example-interwiki',
 874                         'action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb='
 875                                 => 'apihelp-query+siteinfo-example-replag',
 876                 );
 877         }
 878
 879         public function getHelpUrls() {
 880                 return 'https://www.mediawiki.org/wiki/API:Siteinfo';
 881         }
 882 }