23632a4ecd
Which type is used depends on the ApiModuleManager responsible for the API module. There are two managers, one in ApiMain and one in ApiQuery. Both contain a list of API modules they instantiate. Both use $this as the first parameter in the constructors of the individual modules. There is no other regular way to instantiate the modules, so we know the type must either be ApiMain or ApiQuery. The lists don't intersect. I would have prefered the naming scheme $mainModule for ApiMain modules and $queryModule for ApiQuery modules but since this doesn't add much I left the shorter variable names untouched. Change-Id: Ie6bf19150f1c9b619655a06a8e051412665e54db
115 lines
3.3 KiB
PHP
115 lines
3.3 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() {
|
|
$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->getLocalRepo()->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->getLocalRepo()->getInfo() )
|
|
) ) );
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
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',
|
|
);
|
|
}
|
|
}
|