1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
<?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',
);
}
}
|
