includes/api/ApiQueryFileRepoInfo.php

   1 <?php
   2 /**
   3  * Copyright © 2013 Mark Holmquist <mtraceur@member.fsf.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @since 1.22
  22  */
  23
  24 /**
  25  * A query action to return meta information about the foreign file repos
  26  * configured on the wiki.
  27  *
  28  * @ingroup API
  29  */
  30 class ApiQueryFileRepoInfo extends ApiQueryBase {
  31
  32         public function __construct( $query, $moduleName ) {
  33                 parent::__construct( $query, $moduleName, 'fri' );
  34         }
  35
  36         protected function getInitialisedRepoGroup() {
  37                 $repoGroup = RepoGroup::singleton();
  38
  39                 if ( !$repoGroup->reposInitialised ) {
  40                         $repoGroup->initialiseRepos();
  41                 }
  42
  43                 return $repoGroup;
  44         }
  45
  46         public function execute() {
  47                 $params = $this->extractRequestParams();
  48                 $props = array_flip( $params['prop'] );
  49
  50                 $repos = array();
  51
  52                 $repoGroup = $this->getInitialisedRepoGroup();
  53
  54                 $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props ) {
  55                         $repos[] = array_intersect_key( $repo->getInfo(), $props );
  56                 } );
  57
  58                 $repos[] = array_intersect_key( $repoGroup->localRepo->getInfo(), $props );
  59
  60                 $result = $this->getResult();
  61                 $result->setIndexedTagName( $repos, 'repo' );
  62                 $result->addValue( array( 'query' ), 'repos', $repos );
  63         }
  64
  65         public function getCacheMode( $params ) {
  66                 return 'public';
  67         }
  68
  69         public function getAllowedParams() {
  70                 $props = $this->getProps();
  71
  72                 return array(
  73                         'prop' => array(
  74                                 ApiBase::PARAM_DFLT => join( '|', $props ),
  75                                 ApiBase::PARAM_ISMULTI => true,
  76                                 ApiBase::PARAM_TYPE => $props,
  77                         ),
  78                 );
  79         }
  80
  81         public function getProps() {
  82                 $props = array();
  83                 $repoGroup = $this->getInitialisedRepoGroup();
  84
  85                 $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
  86                         $props = array_merge( $props, array_keys( $repo->getInfo() ) );
  87                 } );
  88
  89                 return array_values( array_unique( array_merge( $props, array_keys( $repoGroup->localRepo->getInfo() ) ) ) );
  90         }
  91
  92         public function getParamDescription() {
  93                 $p = $this->getModulePrefix();
  94                 return array(
  95                         'prop' => array(
  96                                 'Which repository properties to get (there may be more available on some wikis):',
  97                                 ' apiurl      - URL to the repository API - helpful for getting image info from the host.',
  98                                 ' name        - The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.',
  99                                 ' displayname - The human-readable name of the repository wiki.',
 100                                 ' rooturl     - Root URL for image paths.',
 101                                 ' local       - Whether that repository is the local one or not.',
 102                         ),
 103                 );
 104         }
 105
 106         public function getDescription() {
 107                 return 'Return meta information about image repositories configured on the wiki.';
 108         }
 109
 110         public function getExamples() {
 111                 return array(
 112                         'api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname',
 113                 );
 114         }
 115 }