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                 $repoGroup->initialiseRepos();
  39                 return $repoGroup;
  40         }
  41
  42         public function execute() {
  43                 $params = $this->extractRequestParams();
  44                 $props = array_flip( $params['prop'] );
  45
  46                 $repos = array();
  47
  48                 $repoGroup = $this->getInitialisedRepoGroup();
  49
  50                 $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props ) {
  51                         $repos[] = array_intersect_key( $repo->getInfo(), $props );
  52                 } );
  53
  54                 $repos[] = array_intersect_key( $repoGroup->getLocalRepo()->getInfo(), $props );
  55
  56                 $result = $this->getResult();
  57                 $result->setIndexedTagName( $repos, 'repo' );
  58                 $result->addValue( array( 'query' ), 'repos', $repos );
  59         }
  60
  61         public function getCacheMode( $params ) {
  62                 return 'public';
  63         }
  64
  65         public function getAllowedParams() {
  66                 $props = $this->getProps();
  67
  68                 return array(
  69                         'prop' => array(
  70                                 ApiBase::PARAM_DFLT => join( '|', $props ),
  71                                 ApiBase::PARAM_ISMULTI => true,
  72                                 ApiBase::PARAM_TYPE => $props,
  73                         ),
  74                 );
  75         }
  76
  77         public function getProps() {
  78                 $props = array();
  79                 $repoGroup = $this->getInitialisedRepoGroup();
  80
  81                 $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
  82                         $props = array_merge( $props, array_keys( $repo->getInfo() ) );
  83                 } );
  84
  85                 return array_values( array_unique( array_merge(
  86                         $props,
  87                         array_keys( $repoGroup->getLocalRepo()->getInfo() )
  88                 ) ) );
  89         }
  90
  91         public function getParamDescription() {
  92                 return array(
  93                         'prop' => array(
  94                                 'Which repository properties to get (there may be more available on some wikis):',
  95                                 ' apiurl      - URL to the repository API - helpful for getting image info from the host.',
  96                                 ' name        - The key of the repository - used in e.g. ' .
  97                                         '$wgForeignFileRepos and imageinfo return values.',
  98                                 ' displayname - The human-readable name of the repository wiki.',
  99                                 ' rooturl     - Root URL for image paths.',
 100                                 ' local       - Whether that repository is the local one or not.',
 101                         ),
 102                 );
 103         }
 104
 105         public function getDescription() {
 106                 return 'Return meta information about image repositories configured on the wiki.';
 107         }
 108
 109         public function getExamples() {
 110                 return array(
 111                         'api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname',
 112                 );
 113         }
 114 }