d94d29a920
We currently only return the image repository name for imageinfo, which is not particularly useful, especially since image repositories aren't accessible via the API. This patch adds meta=filerepoinfo, which will return a list of repositories and relevant information (like the API URL for ForeignAPIRepo ones) Also returns the local repo now, and defaults to "all" in a more useful fashion. Change-Id: I1aaed0895d2a0bc224c82e93975ecf6afd8cb6b8
115 lines
3.4 KiB
PHP
115 lines
3.4 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( $query, $moduleName ) {
|
|
parent::__construct( $query, $moduleName, 'fri' );
|
|
}
|
|
|
|
protected function getInitialisedRepoGroup() {
|
|
$repoGroup = RepoGroup::singleton();
|
|
|
|
if ( !$repoGroup->reposInitialised ) {
|
|
$repoGroup->initialiseRepos();
|
|
}
|
|
|
|
return $repoGroup;
|
|
}
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
$props = array_flip( $params['prop'] );
|
|
|
|
$repos = array();
|
|
|
|
$repoGroup = $this->getInitialisedRepoGroup();
|
|
|
|
$repoGroup->forEachForeignRepo( function ( $repo ) use ( &$repos, $props ) {
|
|
$repos[] = array_intersect_key( $repo->getInfo(), $props );
|
|
} );
|
|
|
|
$repos[] = array_intersect_key( $repoGroup->localRepo->getInfo(), $props );
|
|
|
|
$result = $this->getResult();
|
|
$result->setIndexedTagName( $repos, 'repo' );
|
|
$result->addValue( array( 'query' ), 'repos', $repos );
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
return 'public';
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
$props = $this->getProps();
|
|
|
|
return array(
|
|
'prop' => array(
|
|
ApiBase::PARAM_DFLT => join( '|', $props ),
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_TYPE => $props,
|
|
),
|
|
);
|
|
}
|
|
|
|
public function getProps() {
|
|
$props = array();
|
|
$repoGroup = $this->getInitialisedRepoGroup();
|
|
|
|
$repoGroup->forEachForeignRepo( function ( $repo ) use ( &$props ) {
|
|
$props = array_merge( $props, array_keys( $repo->getInfo() ) );
|
|
} );
|
|
|
|
return array_values( array_unique( array_merge( $props, array_keys( $repoGroup->localRepo->getInfo() ) ) ) );
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
$p = $this->getModulePrefix();
|
|
return array(
|
|
'prop' => array(
|
|
'Which repository properties to get (there may be more available on some wikis):',
|
|
' apiurl - URL to the repository API - helpful for getting image info from the host.',
|
|
' name - The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.',
|
|
' displayname - The human-readable name of the repository wiki.',
|
|
' rooturl - Root URL for image paths.',
|
|
' local - Whether that repository is the local one or not.',
|
|
),
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Return meta information about image repositories configured on the wiki.';
|
|
}
|
|
|
|
public function getExamples() {
|
|
return array(
|
|
'api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname',
|
|
);
|
|
}
|
|
}
|