5b119a0e44
All of core uses implode() consistently now. Change-Id: Iba50898c64c43f356d1caf8869f484e90d9ff651
116 lines
3.2 KiB
PHP
116 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* Copyright © 2013 Mark Holmquist <mtraceur@member.fsf.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @since 1.22
|
|
*/
|
|
|
|
/**
|
|
* A query action to return meta information about the foreign file repos
|
|
* configured on the wiki.
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiQueryFileRepoInfo extends ApiQueryBase {
|
|
|
|
public function __construct( ApiQuery $query, $moduleName ) {
|
|
parent::__construct( $query, $moduleName, 'fri' );
|
|
}
|
|
|
|
protected function getInitialisedRepoGroup() {
|
|
$repoGroup = RepoGroup::singleton();
|
|
$repoGroup->initialiseRepos();
|
|
|
|
return $repoGroup;
|
|
}
|
|
|
|
public function execute() {
|
|
$conf = $this->getConfig();
|
|
|
|
$params = $this->extractRequestParams();
|
|
$props = array_flip( $params['prop'] );
|
|
|
|
$repos = [];
|
|
|
|
$repoGroup = $this->getInitialisedRepoGroup();
|
|
$foreignTargets = $conf->get( 'ForeignUploadTargets' );
|
|
|
|
$repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props, $foreignTargets ) {
|
|
$repoProps = $repo->getInfo();
|
|
$repoProps['canUpload'] = in_array( $repoProps['name'], $foreignTargets );
|
|
|
|
$repos[] = array_intersect_key( $repoProps, $props );
|
|
} );
|
|
|
|
$localInfo = $repoGroup->getLocalRepo()->getInfo();
|
|
$localInfo['canUpload'] = $conf->get( 'EnableUploads' );
|
|
$repos[] = array_intersect_key( $localInfo, $props );
|
|
|
|
$result = $this->getResult();
|
|
ApiResult::setIndexedTagName( $repos, 'repo' );
|
|
ApiResult::setArrayTypeRecursive( $repos, 'assoc' );
|
|
ApiResult::setArrayType( $repos, 'array' );
|
|
$result->addValue( [ 'query' ], 'repos', $repos );
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
return 'public';
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
$props = $this->getProps();
|
|
|
|
return [
|
|
'prop' => [
|
|
ApiBase::PARAM_DFLT => implode( '|', $props ),
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_TYPE => $props,
|
|
],
|
|
];
|
|
}
|
|
|
|
public function getProps() {
|
|
$props = [];
|
|
$repoGroup = $this->getInitialisedRepoGroup();
|
|
|
|
$repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
|
|
$props = array_merge( $props, array_keys( $repo->getInfo() ) );
|
|
} );
|
|
|
|
$propValues = array_values( array_unique( array_merge(
|
|
$props,
|
|
array_keys( $repoGroup->getLocalRepo()->getInfo() )
|
|
) ) );
|
|
|
|
$propValues[] = 'canUpload';
|
|
|
|
return $propValues;
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return [
|
|
'action=query&meta=filerepoinfo&friprop=apiurl|name|displayname'
|
|
=> 'apihelp-query+filerepoinfo-example-simple',
|
|
];
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/API:Filerepoinfo';
|
|
}
|
|
}
|