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( ApiQuery $query, $moduleName ) {
  33                 parent::__construct( $query, $moduleName, 'fri' );
  34         }
  35
  36         protected function getInitialisedRepoGroup() {
  37                 $repoGroup = RepoGroup::singleton();
  38                 $repoGroup->initialiseRepos();
  39
  40                 return $repoGroup;
  41         }
  42
  43         public function execute() {
  44                 $conf = $this->getConfig();
  45
  46                 $params = $this->extractRequestParams();
  47                 $props = array_flip( $params['prop'] );
  48
  49                 $repos = [];
  50
  51                 $repoGroup = $this->getInitialisedRepoGroup();
  52                 $foreignTargets = $conf->get( 'ForeignUploadTargets' );
  53
  54                 $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props, $foreignTargets ) {
  55                         $repoProps = $repo->getInfo();
  56                         $repoProps['canUpload'] = in_array( $repoProps['name'], $foreignTargets );
  57
  58                         $repos[] = array_intersect_key( $repoProps, $props );
  59                 } );
  60
  61                 $localInfo = $repoGroup->getLocalRepo()->getInfo();
  62                 $localInfo['canUpload'] = $conf->get( 'EnableUploads' );
  63                 $repos[] = array_intersect_key( $localInfo, $props );
  64
  65                 $result = $this->getResult();
  66                 ApiResult::setIndexedTagName( $repos, 'repo' );
  67                 ApiResult::setArrayTypeRecursive( $repos, 'assoc' );
  68                 ApiResult::setArrayType( $repos, 'array' );
  69                 $result->addValue( [ 'query' ], 'repos', $repos );
  70         }
  71
  72         public function getCacheMode( $params ) {
  73                 return 'public';
  74         }
  75
  76         public function getAllowedParams() {
  77                 $props = $this->getProps();
  78
  79                 return [
  80                         'prop' => [
  81                                 ApiBase::PARAM_DFLT => implode( '|', $props ),
  82                                 ApiBase::PARAM_ISMULTI => true,
  83                                 ApiBase::PARAM_TYPE => $props,
  84                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
  85                         ],
  86                 ];
  87         }
  88
  89         public function getProps() {
  90                 $props = [];
  91                 $repoGroup = $this->getInitialisedRepoGroup();
  92
  93                 $repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
  94                         $props = array_merge( $props, array_keys( $repo->getInfo() ) );
  95                 } );
  96
  97                 $propValues = array_values( array_unique( array_merge(
  98                         $props,
  99                         array_keys( $repoGroup->getLocalRepo()->getInfo() )
 100                 ) ) );
 101
 102                 $propValues[] = 'canUpload';
 103
 104                 sort( $propValues );
 105                 return $propValues;
 106         }
 107
 108         protected function getExamplesMessages() {
 109                 $examples = [];
 110
 111                 $props = array_intersect( [ 'apiurl', 'name', 'displayname' ], $this->getProps() );
 112                 if ( $props ) {
 113                         $examples['action=query&meta=filerepoinfo&friprop=' . implode( '|', $props )] =
 114                                 'apihelp-query+filerepoinfo-example-simple';
 115                 }
 116
 117                 return $examples;
 118         }
 119
 120         public function getHelpUrls() {
 121                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Filerepoinfo';
 122         }
 123 }